Skip to content

Review the docs before launch - #34

Merged
stphnwlsh merged 3 commits into
mainfrom
feature/docs-review
Nov 8, 2026
Merged

stphnwlsh merged 3 commits into
mainfrom
feature/docs-review

Conversation

@stphnwlsh

@stphnwlsh stphnwlsh commented Nov 8, 2026 •

Copy link
Copy Markdown
Member

Summary

The three-pass review of the live site, applied. Every fact the review caught is corrected (the five "Add a" guides now match code that builds and passes on a fresh solution of each template, one solution name throughout, migration namespace and BOM, HTTPS behind a proxy, what's internal in Infrastructure, the Scalar section name, the reviews_list arguments), the pages that said more than they needed to are shorter, and the site holds up on a phone.

Set up CI now leads with the pipeline a solution ships with and why it's minimal, then lists every check the template runs on itself, what each needs and which to leave out, so an engineer extending the pipeline has the menu on one page. How it's built keeps the rules on main, releases and docs. Make it yours is split under three headings with its tables turned into lists. A long inline code chip wraps like text and a short one stays whole (a small Sätteri hast plugin marks the long ones), tables scroll on narrow screens, and the header and sidebar take less room.

Related issues

Follows LeanMeanCleanApps/.github#78. Touches LeanMeanCleanApps/.github#104 without closing it: How it's built now points at Set up CI for the checks, and the About page is still to come.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Refactoring or clean-up
  • Documentation
  • Build, pipeline or dependency update (@astrojs/markdown-satteri added as a direct dependency; it already ships inside Astro 7)

Checklist

  • npm run build passes and the link check reports every internal link valid.
  • The code in the five "Add a" guides was applied to a fresh solution of each template, and dotnet build, dotnet test and dotnet format --verify-no-changes pass on all five.
  • Checked at 375, 900 and 1440 wide: Make it yours, Add an endpoint, Set up CI, Configuration and the Lambda splash page.
  • The Lambda expose-a-use-case skill is updated in its own PR, since the guide fix exposed that it skipped Invoke.

Fix the facts the three-pass review found, tighten the pages that said more
than they needed to, and make the site hold up on a phone.

Guides: the five "Add a" guides now match code that builds and passes on a
fresh solution, including the operation count test, the Lambda Invoke
wrapper, the MCP tool's XML docs and icon, and the GraphQL snapshot copy.
Make it yours is split under three headings and its tables are lists.
Set up CI leads with the pipeline a solution ships with, then lists every
check the template runs on itself, what each one needs and which to leave
out, so an engineer extending the minimal pipeline has the menu in one
place. How it's built keeps the rules on main, the releases and the docs.

Facts: one solution name throughout, migration namespace and BOM, HTTPS
redirection behind a proxy, which Infrastructure classes are internal,
the Scalar authentication section, the reviews_list arguments and the
service name default.

Design: a long inline code chip wraps like text and a short one stays
whole, tables scroll on a phone, the header and sidebar take less room
and the GitHub link shows on small screens.
@stphnwlsh stphnwlsh self-assigned this Nov 8, 2026
@stphnwlsh
stphnwlsh merged commit 0fb53ba into main Nov 8, 2026
5 checks passed
@stphnwlsh
stphnwlsh deleted the feature/docs-review branch November 8, 2026 18:01
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