Repository navigation
docs: restructure docs.openadapt.ai into Diátaxis sections (for review) - #240
Merged
Merged
Conversation
Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
…s.txt follow the new IA Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
…ion description, section indexes Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
…mission warning up front Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
Adds a 'What these look like' section under the tutorial output table: the receipt.png from a real tutorial run (lossless WebP, 10 KB) and trimmed excerpts of that run's report.json and receipt.json. Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
…te a UI read Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
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
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.
For review. Please don't merge without a product and copy decision: this changes the information architecture of docs.openadapt.ai.
What changes
The sidebar now uses Diátaxis sections. Every page sits in exactly one section (84 nav pages, no duplicates).
get-started/cli.md, new) and the Connect an agent over MCP track (get-started/agent-mcp.md, new) sit next to the existing Desktop app page, followed by Author a workflow and What you get.get-started/index.mdis now a chooser: operating-system permission warnings come first, and the job-link (openadapt.ai/j/{id}) case has its own short section.contributing/index.md): product components and release admission, documentation source of truth, Seal as an RL reward, and the paper.The home page is rewritten. It covers what OpenAdapt is, a demonstrate → compile/certify → execute-and-verify diagram, a 3-command try-it, role-based paths, when it fits, who approves what, and the caller-contract table (transaction outcome → label people see → MCP outcome → what the caller may do).
Security consolidation: hosted retention had three copies of the same facts, so it now has one canonical section in Security and data handling, with short summaries linking to it. The release-integrity paragraph now points to the security review's fuller section. The other overlaps differ in depth on purpose, so they stay.
Glossary: a new Admission entry, plus an intro that points to the qualification, certification, and policy definitions.
docs/QUALIFICATION_TERMS.md(openadapt-flow #532) isn't merged, so there's an HTML-comment TODO in its place.Machine-readable files:
agents.txtnow uses the current MCP commands (uvx --python 3.12 …) and the real outcome vocabulary. The oldREFUSED/TIMEOUT/ERRORvalues don't exist in openadapt-agent.llms.txtfollows the new sections and now lists every nav page, including the commercial ones it was missing.Validator: the
get-started/index.mdmarkers move to the track that owns them (cli.md,agent-mcp.md). The ecosystem catalog may now sit under "Contributing & research". Tests are added for both.URLs and redirects
No file moved, so no published URL changes and no new redirects are needed. All 129 built files from
mainstill exist. The sitemap goes from 81 to 84 URLs, with none dropped. The existingredirect_tostubs still resolve:/start/,/getting-started/,/cli/,/architecture/,/packages/*.Checked against the code
report.json, andreceipt.json(VERIFIED runs only) match a live run ofuvx --python 3.12 openadapt flow tutorial(VERIFIED) andopenadapt quickstart --break-iton macOS.HALTEDwith transaction outcomeRECONCILIATION_REQUIRED("Check the record"), not "nothing was written". The new copy says this.openadapt_flow/approval_mode:each_item(the default),not_gated, andproblems_only(not available to customers yet). The copy names no batch, rule, or delegated approval, because none is on main.openadapt_agent/contract.py. Labels come fromopenadapt_flow/plain_outcome.py.Build
mkdocs build --strictpasses.scripts/validate_docs.pypasses.pytest: 546 passed.Added before merge
get-started/cli.md: a "What these look like" section under the output table, with thereceipt.pngfrom a realopenadapt flow tutorialrun (openadapt 1.17.0, lossless WebP, 10 KB,docs/assets/screenshots/tutorial-receipt.webp) and trimmed excerpts of that run'sreport.jsonandreceipt.json.index.md: theVERIFIEDparagraph now says a system-of-record read is the strongest independent read and a separate UI session is weaker, instead of listing them as equal.