Skip to content

docs(blog): accuracy pass and backfill posts through 0.1.0 beta#57

Open
phil-scott-78 wants to merge 1 commit into
mainfrom
docs/blog-review-and-backfill
Open

docs(blog): accuracy pass and backfill posts through 0.1.0 beta#57
phil-scott-78 wants to merge 1 commit into
mainfrom
docs/blog-review-and-backfill

Conversation

@phil-scott-78

Copy link
Copy Markdown
Contributor

What this is

A tone-and-accuracy pass over the existing blog posts, plus backfill posts for what shipped after the launch batch.

The launch posts were written in one go and carry staged dates (April to May). The code kept moving through June, so several posts drifted from the current API. Each existing post was checked against source; the fixes are small and listed below.

Accuracy fixes

  • In introducing-pennington, AddDocSite takes a Func<DocSiteOptions>, so the original snippet didn't compile.
  • In structured-data-and-accessibility, core now ships JsonLdArticle, JsonLdPerson, JsonLdWebSite, and JsonLdBreadcrumbList, so "ships only one type" was wrong.
  • In llms-txt, the front-door header file is llms-header.txt, not llms.txt (a static llms.txt there would shadow the generated one).
  • In catch-broken-links, four auditors shipped (links, overlap, xref, translation), not two, and the "single source" mechanism claim is softened.
  • In api-reference-from-xmldocs, a duplicated how-to link is removed and the robots-only block is described as a declaration-only C# skeleton rather than plain HTML.
  • build-report-and-dev-overlay, pennington-on-nuget, data-files-and-taxonomies, dotnet-new-templates, and documentation-in-every-language get smaller corrections.

New posts (2026-05-19 to 2026-06-22)

Date Post
05-19 Content tabs, includes, and shortcodes
05-23 Code samples in any language (tree-sitter; Roslyn dropped)
05-26 Search that lands on the right heading (DeweySearch)
05-29 Inspect your site from the command line (build + diag)
06-10 Social cards, generated per page
06-12 Turn your docs into a PDF (Pennington.Book)
06-15 Pennington 0.1.0, in beta
06-22 Color themes

Verification

dotnet run -- diag warnings reports 0 errors, 0 warnings, 0 info: every xref resolves, internal links are valid, and strict front-matter parsing passes.

Out of scope

The .md-twins wording in the llms-txt post (to match the {route}.md change) is left for the llms-twins work. This PR touches only the header-file line in that post.

….0 beta

The launch posts were written in one batch and drifted as the code moved.
Corrections against current source:
- introducing-pennington: AddDocSite takes a Func<DocSiteOptions>
- structured-data: core ships JsonLdArticle/Person/WebSite/BreadcrumbList
- llms-txt: the front-door header file is llms-header.txt, not llms.txt
- catch-broken-links: four auditors shipped, not two; drop the single-source claim
- api-reference: de-dup the how-to link; robots-only is a C# skeleton, not HTML
- build-report, pennington-on-nuget, data-files, dotnet-new-templates,
  documentation-in-every-language: smaller fixes

New posts continuing the timeline (2026-05-19 to 2026-06-22):
- Content tabs, includes, and shortcodes
- Code samples in any language (tree-sitter; Roslyn dropped)
- Search that lands on the right heading (DeweySearch)
- Inspect your site from the command line (build + diag)
- Social cards, generated per page
- Turn your docs into a PDF (Pennington.Book)
- Pennington 0.1.0, in beta
- Color themes

Verified with diag warnings: no broken links, xrefs, or front-matter errors.
@github-actions

Copy link
Copy Markdown

🛰️ Docs preview: https://pr-57.pennington-dev.pages.dev

Rebuilt on every push to this PR; torn down when it closes.

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