Documentation
Waiide
Documentation Cleanup Summary - July 2025

Documentation Cleanup Summary - July 2025

Calliope Integration: This component is integrated into the Calliope AI platform. Some features and configurations may differ from the upstream project.

Overview

Major documentation cleanup to reflect architectural changes made during ECS debugging session.

Key Changes

1. System Paths Updated

  • Old: /home/calliope/WAIIDE-server/ and /home/calliope/scripts/
  • New: /opt/calliope/WAIIDE-server/ and /opt/calliope/scripts/
  • Files Updated:
    • docs/BOOTSTRAP.md
    • docs/architecture/integration-flow.md
    • README.md

2. Default Ports Standardized

  • Old: Mix of 8080/8081 in various docs
  • New: Consistent 8070/8071 throughout
  • Files Updated:
    • README.md
    • docs/api/overview.md
    • docs/architecture/integration-flow.md
    • Multiple configuration examples

3. WAIIDE URL Path

  • Old: WAIIDE at root (/) or /proxy/8081/
  • New: WAIIDE at /ide
  • Files Updated:
    • All spawner configurations
    • docs/BOOTSTRAP.md
    • Quick start guides

4. Archived Outdated Documentation

Moved to docs/archive/outdated-2025-07/:

  • ecs-boot-errors.md - Referenced old paths
  • m2-mac-build-issues.md - Referenced old architecture
  • ecs-deployment-mismatch.md - Outdated troubleshooting

5. Configuration Examples Updated

Fixed all JupyterHub configuration examples:

  • Changed c.Spawner.default_url from /proxy/8081/ to /ide
  • Updated port references from 8080 to 8070
  • Removed hardcoded path references

Files Not Updated (Still Need Review)

May Need Updates:

  • docs/architecture/services.md - Still references port 8080
  • docs/reference/ - Several files with legacy patterns
  • docs/troubleshooting/oauth-issues.md - May have outdated workarounds

Intentionally Kept As-Is:

  • docs/configuration/examples/hub_config.py - Already correct
  • docs/getting-started/basic-setup.md - Uses correct patterns

Migration Guide

Created docs/archive/MIGRATION-2025-07.md documenting:

  • What changed and why
  • Migration steps for existing deployments
  • Testing checklist
  • Known issues fixed

Next Steps

  1. Review Remaining Docs: Check files in docs/reference/ for accuracy
  2. Test Documentation: Ensure all examples work with new architecture
  3. Update External References: Any wikis or external docs pointing to old patterns
  4. User Communication: Notify users of the /ide path change

Validation Checklist

  • Bootstrap file reflects current architecture
  • Port references are consistent (8070/8071)
  • System paths use /opt/calliope/
  • WAIIDE URL is /ide not root
  • Outdated docs are archived
  • All examples have been tested
  • External documentation updated
Common Issues and SolutionsECS Deployment Fixes