Skip to content

docs: give the site its own landing page instead of rendering the README - #194

Merged
imran-siddique merged 1 commit into
mainfrom
docs/site-landing-page
Aug 21, 2026
Merged

docs: give the site its own landing page instead of rendering the README#194
imran-siddique merged 1 commit into
mainfrom
docs/site-landing-page

Conversation

@imran-siddique

Copy link
Copy Markdown
Member

trace.agentrust-io.com was the GitHub README rendered verbatim: a centered icon, a five-line H1, six shields in colours the editorial palette does not use, and a "Full Documentation" badge linking to the page the reader is already on. Roughly a screen and a half of chrome before the first sentence of content. Agent Manifest already does this properly with a purpose-written index.md; this brings TRACE onto that pattern.

Landing page

  • New index.md: title, lead paragraph, the promise in one line, a TL;DR block, the claim table, a four-card "where to start", and status and governance.
  • README.md stays the GitHub landing page and is excluded from the build, so the project no longer has two homepages.
  • Drops the htmltitle override in overrides/main.html. It existed only because README.md could not carry front matter without rendering YAML as noise on GitHub. The OG and Twitter titles now use the real page title on the homepage too.

Fixes found along the way

Problem Status
CODE_OF_CONDUCT.md, MAINTAINERS.md, CHARTER.md linked from GOVERNANCE/ROADMAP but excluded from the build, so all three 404'd live Published, and in the nav under Project
docs/conformance-method.md written but unreachable: not in nav, not linked anywhere Added under Method
Spec badge read v0.1 while linking to and describing v0.2 Corrected
"Launching at Confidential Computing Summit, June 23 2026" still read as a future event Now past tense, with the current spec version
Crosswalk link to tests/test_acta_fixtures.py 404'd (tests/ is not published) Points at GitHub

The docs build goes from nine link warnings to zero.

Verified by reproducing the CI build locally (.docs_build + docs_dir rewrite) and viewing the result.

🤖 Generated with Claude Code

https://claude.ai/code/session_013EQx4N5BzTQbY8kvXUsdkY

trace.agentrust-io.com was the GitHub README verbatim: a centered icon, a
five-line H1, six shields in colours the editorial palette does not use,
and a "Full Documentation" badge linking to the page the reader is
already on. About a screen and a half of chrome before the first
sentence of content.

- Adds index.md as the site landing page, in the shape Agent Manifest
  already uses: title, lead paragraph, the promise, a TL;DR, the claim
  table, a four-card "where to start", and status and governance.
  README.md stays the GitHub landing page and is excluded from the build
  so the project does not have two homepages.
- Removes the htmltitle override in overrides/main.html, which only
  existed because README.md could not carry front matter, and lets the
  OG and Twitter titles use the real page title on the homepage too.

Fixes found while doing it:

- CODE_OF_CONDUCT.md, MAINTAINERS.md and CHARTER.md were linked from
  GOVERNANCE.md and ROADMAP.md but excluded from the build, so all three
  404'd on the live site. Now published and in the nav.
- docs/conformance-method.md was written but unreachable: not in the nav
  and not linked from anywhere. Now under Method.
- The Spec badge said v0.1 while linking to, and describing, v0.2.
- "Launching at Confidential Computing Summit, June 23 2026" read as a
  future event two months after the fact.
- A crosswalk link to tests/test_acta_fixtures.py 404'd, because tests/
  is not part of the published site. Points at GitHub now.

The docs build goes from nine link warnings to zero.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013EQx4N5BzTQbY8kvXUsdkY
@imran-siddique
imran-siddique requested a review from a team as a code owner August 21, 2026 00:51
@imran-siddique
imran-siddique merged commit 5dba0e4 into main Aug 21, 2026
6 checks passed
@imran-siddique
imran-siddique deleted the docs/site-landing-page branch August 21, 2026 00:56
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