Skip to content

docs: sync from help-docs (source of truth) - #1083

Merged
saravmajestic merged 2 commits into
mainfrom
docs/sync-from-help-docs
Aug 14, 2026
Merged

docs: sync from help-docs (source of truth)#1083
saravmajestic merged 2 commits into
mainfrom
docs/sync-from-help-docs

Conversation

@saravmajestic

@saravmajestic saravmajestic commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Initial docs sync from AltimateAI/help-docs, which is now the source of truth for documentation.

  • Content-only mirror generated by help-docs tools/sync_to_oss.py.
  • Edit docs in help-docs, not here — each file carries a do-not-edit banner; this copy is regenerated automatically.
  • Non-destructive: repo-only files (CNAME, overrides/, css, requirements, and any repo-only pages) are preserved, not deleted.
  • Unified-site links de-prefixed; mkdocs.yml nav regenerated from help-docs.

First sync is large because help-docs content was developed substantially post-migration. Please review; anything here that should live in help-docs instead can be pulled back before merge.

🤖 Generated with Claude Code


Summary by cubic

Syncs docs from AltimateAI/help-docs and refreshes homepage/nav/styles. Consolidates Quickstart (Setup folded in) and removes the orphaned top-level /quickstart/ page; all Quickstart links now point to getting-started/quickstart/.

  • Migration

    • Source of truth is AltimateAI/help-docs; this repo mirrors via help-docs/tools/sync_to_oss.py (prunes orphans, preserves repo-only assets).
    • Deleted docs/docs/quickstart.md to eliminate route drift; update any remaining links to getting-started/quickstart/ (external /quickstart/ relies on help-docs 301).
    • IA updates: removed getting-started/quickstart-new.md; Quickstart is a single canonical page; moved CI guide to usage/ci-headless.md; mkdocs.yml nav regenerated.
    • Links canonicalized to help.altimate.ai where appropriate; docs/docs/llms.txt regenerated with updated date and canonical source.
  • Review focus

    • Added brand styles and assets: assets/stylesheets/{extra.css,neoteroi-cards.css,copy-page.css} and assets/brand/logo-white.svg; wired via extra_css with a “Copy page” control.
    • Front matter titles/descriptions added across pages; homepage replaced with a real landing page.
    • Privacy/telemetry docs clarify CLI browser-auth identifiers and retention.
    • IDE docs reflect “Altimate MCP” naming; permissions/keybinds remove the in-TUI Ctrl+Y yolo toggle.

Written for commit dc119ea. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added titles and descriptions across configuration, usage, reference, development, and data engineering pages to improve navigation and search.
    • Reworked navigation with Overview, integrations, tools, examples, and FAQ content.
    • Replaced the documentation home redirect with a branded Altimate Code landing page featuring product highlights, benchmarks, and quick links.
    • Rewrote the Quickstart, added a comprehensive setup guide, and updated links, branding, integrations, and telemetry guidance.
  • Style
    • Added responsive themes, cards, homepage layouts, navigation enhancements, and a themed Copy page control.

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants