Repository navigation
Add documentation site and rewrite README for discoverability - #3
Merged
Merged
Conversation
- MkDocs Material site published to GitHub Pages from docs/: new landing page, quickstart, how it works, comparison, FAQ, and a CLUE.md spec page that includes the root spec. System fonts, no analytics or CDN requests. - SEO: per-page meta descriptions and titles, canonical URLs, Open Graph and Twitter cards with a share image, SoftwareApplication and FAQPage JSON-LD, and the built-in sitemap. - Real screenshots of the review queue and runbook promotion from the demo. - README rewritten around the problem, quickstart, features and status, with badges and links into the docs site. - docs workflow builds strictly on PRs and deploys to Pages from main; pyproject gains a docs extra, keywords, classifiers and project URLs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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.
Adds a GitHub Pages docs site and rewrites the README so the project is easier to find and evaluate.
Docs site (MkDocs Material →
https://drdroidlab.github.io/hindsight/)CLUE.mdrather than copying it.docs/pages are now in the site nav; links that pointed outsidedocs/now use site or GitHub URLs, and each page has a meta description.SEO
SoftwareApplicationJSON-LD on the home page;FAQPageJSON-LD generated from the same front matter that renders the FAQ.sitemap.xml.pyproject.toml: keywords, classifiers, project URLs (shown on PyPI), and adocsextra.README
Problem statement, quickstart, features, what it is not, security, honest project status, badges, and links into the docs site.
Deploy
.github/workflows/docs.ymlrunsmkdocs build --stricton PRs and deploys to Pages frommain.Before merge: enable Pages with source GitHub Actions (Settings → Pages), or the deploy job will fail.
Verification
mkdocs build --strictpasses; checked in a browser in light and dark mode, including meta tags, JSON-LD and that no third-party requests are made.python -m buildpasses with the updatedpyproject.toml.🤖 Generated with Claude Code