Skip to content

Docs site on GitHub Pages: indexable docs, canonical article, llms.txt - #45

Merged
csa7mdm merged 9 commits into
mainfrom
site/pages
Sep 24, 2026
Merged

csa7mdm merged 9 commits into
mainfrom
site/pages

Conversation

@csa7mdm

@csa7mdm csa7mdm commented Sep 24, 2026

Copy link
Copy Markdown
Owner

Makes the documentation findable by search engines and AI assistants. Why: GitHub only lets search engines index a wiki with 500+ stars and public editing disabled (GitHub docs), so none of the wiki currently ranks.

What's in it

  • docs/docs/: the 11 wiki pages, word for word, with Jekyll front matter and relative links. Each page has a full-sentence meta description of 155 characters or fewer. The wiki stays as it is.
  • docs/articles/polly-benchmark/: the canonical version of the Medium article:
    • semantic HTML; each H2 is phrased as a question;
    • a Key facts box with the conditions attached to each number;
    • JSON-LD (SoftwareApplication, Person, TechArticle, Dataset);
    • Open Graph tags with a 1200×630 PNG card.
  • docs/llms.txt / docs/llms-full.txt: an index of the docs in Markdown for AI tools, plus all docs in one file.
  • docs/index.md: a landing page. docs/_config.yml: Jekyll with jekyll-sitemap.
  • One definition everywhere: the NuGet <Description> is now "DotNetDevMCP is an open-source MCP server that gives AI coding agents Roslyn's compiler view of a .NET solution." server.json gets an 81-character form, because the registry allows at most 100.

Checks

  • Build: built with GitHub Pages' Jekyll (jekyll/jekyll:pages); no errors. The output has 11 docs pages, the article, llms.txt, robots.txt, and a sitemap with 13 URLs.
  • JSON-LD parses.
  • Every number on the article page traces to the article or benchmarks/polly/README.md (checked by script).
  • Wiki fidelity: word counts match the wiki page for page (checked by script).

After merge (you)

  1. Settings → Pages → Source: Deploy from a branch, Branch main, folder /docs.
  2. Set the repo's About description and homepage: gh repo edit csa7mdm/DotNetDevMCP --description "DotNetDevMCP is an open-source MCP server that gives AI coding agents Roslyn's compiler view of a .NET solution." --homepage "https://csa7mdm.github.io/DotNetDevMCP/"
  3. Replace the two author sameAs placeholders in the article's JSON-LD with your LinkedIn and Medium profile URLs (or tell me them).

Built by sub-agents (Haiku: docs migration, metadata; Sonnet: canonical page) and reviewed by the lead session, which fixed invalid YAML, truncated descriptions, an SVG og:image and a heading.

🤖 Generated with Claude Code

csa7mdm and others added 9 commits September 24, 2026 11:39
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@csa7mdm
csa7mdm merged commit 4f53c43 into main Sep 24, 2026
6 of 7 checks passed
@csa7mdm csa7mdm mentioned this pull request Sep 25, 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