docs: repair docs navigation and replay runbook#229
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Sara Loera <saraeloop@users.noreply.github.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.
Overview
Repair stale and missing documentation entry points, and align the determinism/replay runbook with the shipped diagnostics CLI and CI replay gate.
Type of Change
Motivation & Context
The docs navigation advertised
reference/llms-txtwithout a backing page, several existing tutorials were not discoverable in the Mintlify sidebar, README links pointed at stale docs paths, and the determinism page referenced non-existent replay workflow/script names.Technical Details
docs/reference/llms-txt.mdxand keptllms.txtaligned with existing public pages.docs/docs.jsonto include existing tutorial pages in navigation.docs/explanation/determinism.mdxanddocs/reference/cli.mdxto covernoesis diagnostics replay,noesis.diagnostics.compare_runs(),scripts/replay_gate.py, and.github/workflows/determinism-replay.yml.docs/app/reference/*todocs/reference/*.Validation
Required
uv run pytest) or equivalent targeted suiteValidation performed:
git diff --check HEAD~1..HEADdocs/docs.jsonnavigation targets,llms.txtpublic URL targets, and fenced code block balance in changed Markdown/MDX files.Schema validation was not run because this is a docs-only change with no schema files modified.
Situational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)Docs build was not run because this repository does not include a docs package manifest; structural docs validation was run instead.
ADR-003 Schema Governance Checklist
$schema_versionbumped for every artifact whose stable fields changeddocs/schema/**regenerated (no diff afterpython scripts/gen_schema.py)internal_docs/schema/kpi*.yamlMIGRATIONS.schema.mdorMIGRATIONS.kpi.mdpython scripts/schema_guard.py --strict --jsonpasses locallydocs/reference/*updated when new fields/KPIs surface to usersNot applicable: documentation-only change; no artifact fields, schemas, or KPIs changed.
Observability & Safety
Improves operational docs for replay drift debugging and LLM-facing docs index hygiene. No runtime behavior changed.
Educational / Research Value
Makes determinism and replay workflows easier to discover and run for eval/regression work.
Screenshots / Logs
Related Issues / References
noesis/cli/commands/diagnostics.py,noesis/diagnostics/replay.py,scripts/replay_gate.py,.github/workflows/determinism-replay.yml.