feat: restructure docs into Getting Started, Guides, and Reference#24
Open
synchwire wants to merge 3 commits into
Open
feat: restructure docs into Getting Started, Guides, and Reference#24synchwire wants to merge 3 commits into
synchwire wants to merge 3 commits into
Conversation
✅ Deploy Preview for ordo-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Split the single Getting Started walkthrough into five ordered pages (Introduction, Install, Bootstrap the orchestrator, Connect your first agent, Your first apply) and add a Guides section: writing state modules, drift & plan mode, secrets, and progressive deployment. Content is grounded in the ordo code, design docs, and generated CLI reference. Progressive deployment is marked "Planned" and not-yet- available (Fleet operations is unimplemented on the roadmap). The "Concepts" stub is folded into Guides.
synchwire
force-pushed
the
feat/docs-restructure
branch
from
971c477 to
809481e
Compare
Bring the Starlight docs onto the marketing brand: dark navy palette with cyan accents, Schibsted Grotesk / IBM Plex Mono fonts, the Ordo arch mark as the logo, a "DOCS" pill on the wordmark, a filled-cyan active sidebar entry, and a getordo.dev link in the header cluster.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Accuracy
Every page is grounded in the
ordocode, design docs, and the generated CLI reference. Verified before writing: resource kinds and module fields (against the module JSON Schema andexamples/caddy-site.ordo.yaml), change triggers (reload_on/restart_on/rerun_on), the secret expression syntax (${{ secrets.name }}), server-side resolution + at-rest encryption + redaction + tag/node scoping, plan/drift semantics, and the exact CLI command surface (ordo state plan|apply|drift,ordo secrets …,ordo assignments …). Module upload is described as web-UI/API only — there is no CLI upload command, so none is invented.Corrected vs. the design:
v0.1.0version pill in the mock is also ahead of the currentv0.0.7.)Verification
npm run buildpasses (100 pages, Pagefind index built). All authored internal links resolve, including the five Getting Started pages, four Guides, and/reference/api/.