Phase 1: GitHub Pages docs site + AI-search discovery layer - #1
Merged
Conversation
Build a MkDocs (Material) documentation site from the repo's own markdown so AI crawlers and search engines can index the project, and publish the llms.txt-family files for LLM consumers: - README SEO quick wins: intro names both "AI Engineering Lab" and "Provider-Aware Statusline", hosted-site pointer, FAQ, repo-map row, absolute tests-badge URL - mkdocs.yml: Material dark theme, explicit nav, strict build - requirements.txt: pinned mkdocs + mkdocs-material - robots.txt: allow all crawlers, point at sitemap - Scripts/assemble-site-source.js: stage tracked docs + assets into a gitignored docs/ (MkDocs requires docs_dir to be a child directory) - Scripts/generate-llms.js: generate llms.txt + llms-full.txt from the same source markdown, links rewritten to absolute site URLs - CI: new docs job runs mkdocs build --strict on every push/PR - Deploy: deploy-site.yml publishes the site to GitHub Pages on main The repo root stays the single source of truth; docs/ and site/ are gitignored staging/build output. Co-Authored-By: Claude <noreply@anthropic.com>
UnscriptedByKraMy
marked this pull request as ready for review
August 6, 2026 07:32
UnscriptedByKraMy
added a commit
that referenced
this pull request
Aug 6, 2026
Build a MkDocs (Material) documentation site from the repo's own markdown so AI crawlers and search engines can index the project, and publish the llms.txt-family files for LLM consumers: - README SEO quick wins: intro names both "AI Engineering Lab" and "Provider-Aware Statusline", hosted-site pointer, FAQ, repo-map row, absolute tests-badge URL - mkdocs.yml: Material dark theme, explicit nav, strict build - requirements.txt: pinned mkdocs + mkdocs-material - robots.txt: allow all crawlers, point at sitemap - Scripts/assemble-site-source.js: stage tracked docs + assets into a gitignored docs/ (MkDocs requires docs_dir to be a child directory) - Scripts/generate-llms.js: generate llms.txt + llms-full.txt from the same source markdown, links rewritten to absolute site URLs - CI: new docs job runs mkdocs build --strict on every push/PR - Deploy: deploy-site.yml publishes the site to GitHub Pages on main The repo root stays the single source of truth; docs/ and site/ are gitignored staging/build output. Co-authored-by: Claude <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
1 participant
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.
Phase 1 of AI Search & SEO optimization for AI-Engineering-Lab
Builds a GitHub Pages documentation site from the repo's own markdown so AI crawlers and search engines can index the project, plus the llms.txt-family files for LLM consumers.
mkdocs.yml(Material, dark),requirements.txt(pinned),robots.txt(allow all crawlers + sitemap pointer)assemble-site-source.jsstages tracked docs into a gitignoreddocs/;generate-llms.jsemitsllms.txt+llms-full.txtwith absolute rewritten linksdocsjob runsmkdocs build --strict(fails on any warning/broken link) on every push/PRdeploy-site.ymlpublishes to GitHub Pages on main (workflow_dispatchavailable)Repo root stays the single source of truth;
docs/andsite/are gitignored staging/build output.Manual steps after merge (blocked on
ghinstall + auth):build_type=workflowgh repo edit— description, homepage, 20 topics🤖 Generated with Claude Code