Skip to content

docs: add ReadTheDocs MkDocs scaffold#351

Open
raoabinav wants to merge 2 commits into
StarTrail-org:mainfrom
raoabinav:codex/p0-readthedocs
Open

docs: add ReadTheDocs MkDocs scaffold#351
raoabinav wants to merge 2 commits into
StarTrail-org:mainfrom
raoabinav:codex/p0-readthedocs

Conversation

@raoabinav
Copy link
Copy Markdown
Contributor

@raoabinav raoabinav commented Jun 3, 2026

Evaluator Summary

  • Abi added the hosted documentation scaffold for LEANN using MkDocs and ReadTheDocs, including navigation, landing pages, and strict docs-build CI.
  • The design keeps docs as repository-native Markdown with a strict build gate, so broken links or stale docs fail before publication.
  • The implementation adds ReadTheDocs config, MkDocs config, docs workflow, contributor docs-build guidance, and fixes links that become enforced by the stricter build.
  • Quality bar: strict MkDocs build and diff checks were run; this PR intentionally sets up hosting infrastructure but does not claim the public site is already published.

@raoabinav raoabinav force-pushed the codex/p0-readthedocs branch from 47c0d2b to 3d0a008 Compare June 3, 2026 18:02
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