Repository navigation
docs: make Reference > Glossary the one place terms are defined - #242
Merged
Merged
Conversation
Adds Qualify, Certify and Certification policy entries that match the engine's qualification terms, now on the monorepo's main, and resolves the TODO waiting for them. Old anchors (#qualification, #certification, #policy) still land on the same entries. Adds Bundle, Demonstration and Runner. The Substrate entry now says OpenAdapt reads every substrate from what is on screen, with DOM, UIA, AX or AT-SPI as added evidence where they exist. The plain-language glossary, Reference index and llms.txt point at this page as the canonical source.
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.
Richard wants key terms such as "qualify" defined in one place that the README, the docs and the CLI help can all link to. This makes Reference > Glossary that place. It builds on the #240 structure and moves no pages.
Changes
#qualify), Certify (#certify) and Certification policy (#certification-policy) replace the old Qualification, Certification and Policy entries. They match the engine's terms page,packages/flow/docs/QUALIFICATION_TERMS.md, which is now on the monorepo's main. That resolves the TODO waiting on openadapt-flow#532. Each entry links to the engine page for the details: the fault cases, what gets signed, and the policy rules.#qualification,#certificationand#policyare kept as<a id>targets, so existing links still land on the right entry.llms.txtnow point at this page as the canonical definitions. The plain-language page stays a map from plain terms to these entries.qualify --certifyisn't in a Flow release yet (tests/test_documented_flow_options.pychecks documented options against the released CLI), so the Certify entry names it as amain-only option.Checks
mkdocs build --strict,scripts/validate_docs.pyandpytest testsall pass (546 passed, 1 skipped).--include-fragments, over the built site: 1,146 unique links, 0 errors.Follow-ups
qualifyhere in OpenAdaptAI/OpenAdapt (the README PR).docs/QUALIFICATION_TERMS.md, which means nothing to someone who installed from PyPI, and one help string uses a#policiesanchor that doesn't exist. That's package code, which the carry-over work is changing right now, so it's left for after the carry-over.