Skip to content

Documentation Maintenance

Jump to bottom
Varun S V edited this page Oct 16, 2026 · 1 revision

Documentation Maintenance

The authoritative public documentation destination is the Cascade AI GitHub Wiki, not a docs/wiki folder in the application repository. The Wiki is a separate Git repository with its own Home.md and _Sidebar.md.

How this Wiki is updated

  1. The maintainer initially uploads the complete Markdown Wiki pack manually.
  2. Every Friday, a scheduled Cascade Wiki review checks actual code merged to main since the preceding review, along with relevant tests, configuration, routes and user-facing behavior.
  3. Only when a page must change or be added, the review delivers a ZIP containing the complete revised/new .md pages only. If navigation changes, it also includes _Sidebar.md.
  4. The maintainer replaces/creates those pages manually in GitHub Wiki. No automatic publishing, application-repository PR, or main-branch file change is required.
  5. If no material documentation updates are necessary, there is no update package.

Manual application

  • Extract the update ZIP. The files use GitHub Wiki page names such as Models-and-Budgets.md and _Sidebar.md.
  • Open the corresponding Wiki page and choose Edit, then replace its entire Markdown content with the updated file (or create a page for a new filename). Save with a descriptive edit summary.
  • For _Sidebar.md, edit/create the sidebar file in the separate Wiki Git repository if GitHub's UI does not expose it. The GitHub Wiki's own Git remote can also be cloned and pushed using appropriately authorized Git credentials.
  • Check navigation and code examples after saving; verify the updated page is visible publicly.

GitHub Wiki Git remote (for maintainers):

git clone https://github.com/Varun-SV/Cascade-AI.wiki.git
# Put Home.md, _Sidebar.md and other *.md files in this clone.
git add '*.md'
git commit -m "docs: update Cascade Wiki"
git push origin HEAD

Clone/push requires an initialized Wiki and write-capable credentials; the commands above must run in a separate directory from the application checkout. Do not run them inside your Cascade application repository.

Review rules

  • Document only merged functionality; an open PR or roadmap proposal is not yet a shipped feature.
  • Inspect implementation and tests, not merely commit titles and README claims.
  • Record surface-specific distinctions: CLI vs desktop vs hosted/self-hosted web vs SDK/API.
  • Check authentication, credential boundaries, permissions and deployment caveats.
  • Make full-page replacement files for changed pages, not partial diffs that a maintainer must manually patch.
  • Never include actual tokens, passwords, sensitive incidents or private user content.
  • Preserve manually curated Wiki pages not requiring an update.

Source baseline

Initial Wiki Markdown pack checked against main commit 352726b, cascade-ai version 0.82.0. Subsequent review packages should include their reviewed main commit SHA and identify added versus updated pages.

Cascade AI Wiki

Clone this wiki locally