Skip to content

docs: five-tab menu and a clean landing page - #113

Merged
imran-siddique merged 1 commit into
mainfrom
docs/five-tab-nav
Sep 14, 2026
Merged

imran-siddique merged 1 commit into
mainfrom
docs/five-tab-nav

Conversation

@imran-siddique

Copy link
Copy Markdown
Member

tests.agentrust-io.com had eight top-level tabs: Home, Getting Started, Tutorials, Test Modules, Conformance Levels, Error Codes, Self-verification, Project. Three of those were single pages promoted to a tab, and the other AgenTrust docs sites each used a different set.

This moves the suite to the menu all six docs sites now share: Home, Get started, Specification, Guides, Project.

Where the pages went

  • Get started: docs/quickstart.md.
  • Specification: Conformance levels, Test modules with the eight module pages (TR-ENV to TR-SCA), Error codes.
  • Guides: Writing conformance tests, CI integration, Self-verification (measurement/REPORT.md).
  • Project: Known limitations, Changelog, Contributing, Sponsors, Code of conduct, Privacy. Known limitations moves to the top of the section.

No file is renamed and no page leaves the nav: flattening the old and new nav lists gives the same 22 entries. The build allowlist in docs.yml needed no change, because every page was already copied.

Landing page. index.md adds hide: [navigation, toc] to its front matter, so the home page renders full width under the tabs. Inner pages keep the left menu and the table of contents. The landing text, including the eight modules and the obligation accounting lines the guard tests read, is unchanged.

Theme features. The list matches the other docs sites: navigation.instant.progress is removed and content.tabs.link is added; content.code.annotate stays.

Checked

  • Replicated docs.yml: copied the allowlist into .docs_build, rewrote docs_dir with the same sed, and ran mkdocs build --config-file .mkdocs_build.yml (mkdocs 1.6.1, mkdocs-material 9.7.7 from requirements/docs.txt). It builds with no warnings.
  • The built home page lists the tabs as Home, Get started, Specification, Guides, Project, and marks both sidebars hidden; docs/quickstart/ keeps both.
  • pytest tests/test_docs_match_the_modules.py tests/test_obligation_accounting.py: 82 passed.
  • Headless Chrome screenshots of the home page and the quickstart at 1400x900.

Generated with Claude Code

https://claude.ai/code/session_013aK3gVWzNdcM3hZ2o2awK2

tests.agentrust-io.com had eight top-level tabs, three of them single pages.
It now has the five every AgenTrust docs site uses: Home, Get started,
Specification, Guides, Project. Conformance levels, the eight test modules
and error codes sit under Specification; the two tutorials and the
self-verification report under Guides. All 22 nav entries are still present.

The home page hides the left menu and the table of contents. The theme
feature list matches the other docs sites: navigation.instant.progress goes,
content.tabs.link joins.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013aK3gVWzNdcM3hZ2o2awK2
@imran-siddique
imran-siddique requested a review from a team as a code owner September 14, 2026 20:58
@imran-siddique
imran-siddique merged commit 4b31256 into main Sep 14, 2026
7 checks passed
@imran-siddique
imran-siddique deleted the docs/five-tab-nav branch September 14, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant