Skip to content

docs: add ReadTheDocs MkDocs scaffold#356

Closed
raoabinav wants to merge 4 commits into
StarTrail-org:mainfrom
raoabinav:docs/readthedocs-mkdocs
Closed

docs: add ReadTheDocs MkDocs scaffold#356
raoabinav wants to merge 4 commits into
StarTrail-org:mainfrom
raoabinav:docs/readthedocs-mkdocs

Conversation

@raoabinav
Copy link
Copy Markdown
Contributor

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
Copy link
Copy Markdown
Contributor Author

Parking this PR for now to keep the review queue focused on #347. I’ll revisit/reopen this work later as a smaller clean PR once the content-hash PR lands.

@raoabinav raoabinav closed this Jun 6, 2026
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