Skip to content

FROM feat/501-update-stale-docs-with-placeholder TO development#502

Merged
ryaneggz merged 2 commits intodevelopmentfrom
feat/501-update-stale-docs-with-placeholder
Nov 16, 2025
Merged

FROM feat/501-update-stale-docs-with-placeholder TO development#502
ryaneggz merged 2 commits intodevelopmentfrom
feat/501-update-stale-docs-with-placeholder

Conversation

@ryaneggz
Copy link
Copy Markdown
Collaborator

@ryaneggz ryaneggz commented Nov 16, 2025

Closes #501

Summary by CodeRabbit

Release Notes

  • Documentation

    • Expanded assistant configuration guides with detailed setup and advanced examples
    • Added comprehensive Getting Started guide covering setup and platform navigation
    • Enhanced storage and threads documentation with full API references
    • Updated API endpoint references and added development status notes
    • Reorganized documentation structure with new navigation sections and improved branding
  • Chores

    • Updated Docker ignore patterns and documentation configuration

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 16, 2025

Walkthrough

This PR substantially expands documentation across the platform: replaces placeholder documentation in Assistants, Threads, and Storage with comprehensive guides; updates API endpoint references from demo.enso.sh to orchestra.enso.sh; restructures backend mkdocs navigation and homepage content; adds a new Getting Started guide; and updates the Changelog with a v0.0.2 entry.

Changes

Cohort / File(s) Summary
Changelog & Ignores
Changelog.md, backend/.dockerignore
Added v0.0.2 changelog entry; added **/.plans/ ignore pattern to Docker build exclusions.
Documentation Infrastructure
backend/mkdocs.yml
Restructured navigation with Home, Getting Started, Core Features (Assistants, Threads, Storage, Projects, Prompts), Tools & Integrations, and API Documentation; expanded markdown extensions, theme features, site metadata, branding, and social links.
Core Feature Documentation
docs/assistants/index.md, docs/threads/index.md, docs/storage/index.md
Replaced placeholder content with comprehensive multi-section documentation including overviews, key concepts, usage guides, configuration examples, API references, best practices, and code examples for each feature.
Homepage & Onboarding
docs/index.md, docs/getting-started.md
Updated homepage with "What is Ensō Orchestra?" and "Who Is This For?" sections; restructured features with descriptions and links (Assistants, Threads, Protocol Integration, Storage & RAG); added Quick Start guide and Community & Support section. Added new Getting Started guide covering prerequisites, 5-minute quick start, UI walkthrough, and advanced features overview.
Tools & Integration Documentation
docs/tools/a2a.md, docs/tools/mcp.md, docs/tools/tools.md
Updated API endpoint references from demo.enso.sh to orchestra.enso.sh; added development warning block (A2A, MCP); expanded MCP configuration documentation with JSON examples; restructured tools overview to emphasize Base Tools (Platform Tools) concept with creation examples, usage patterns, priority ordering, and API references.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • docs/assistants/index.md, docs/threads/index.md, docs/storage/index.md: Each requires careful review for accuracy, completeness of API examples, consistency with actual implementation, and proper cross-referencing to other documentation sections.
  • backend/mkdocs.yml: Navigation restructuring and configuration changes need verification to ensure proper site structure and rendering.
  • docs/tools/tools.md: Substantial reorganization introducing "Base Tools" concept with multiple code examples requires validation against actual API behavior.
  • docs/index.md: Homepage restructuring affects user onboarding flow and should be reviewed for clarity and appropriate prominence of features.
  • URL migrations: All references changing from demo.enso.sh to orchestra.enso.sh should be verified to point to correct active endpoints.

Poem

🐰 Docs were bare, just placeholders gray,
Now they bloom with guides on every day!
From threads to tools, from start to end,
A hop and skip to help new friends—
Orchestra shines, the docs now sing! 🎼✨


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 68cae4c and cbdfadb.

📒 Files selected for processing (11)
  • Changelog.md (1 hunks)
  • backend/.dockerignore (1 hunks)
  • backend/mkdocs.yml (2 hunks)
  • docs/assistants/index.md (1 hunks)
  • docs/getting-started.md (1 hunks)
  • docs/index.md (1 hunks)
  • docs/storage/index.md (1 hunks)
  • docs/threads/index.md (1 hunks)
  • docs/tools/a2a.md (3 hunks)
  • docs/tools/mcp.md (3 hunks)
  • docs/tools/tools.md (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@ryaneggz ryaneggz marked this pull request as ready for review November 16, 2025 22:24
@ryaneggz ryaneggz merged commit d81ce17 into development Nov 16, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FEAT: Docs refresh (placeholder for now)

1 participant