Skip to content

Give the README and package READMEs the shared nullean shape - #54

Merged
Mpdreamz merged 1 commit into
mainfrom
docs/readme-standard
Nov 11, 2026
Merged

Mpdreamz merged 1 commit into
mainfrom
docs/readme-standard

Conversation

@Mpdreamz

Copy link
Copy Markdown
Contributor

Gives the root README the shared nullean structure, and gives Nullean.Cdp, Nullean.Cdp.Journeys and Nullean.Cdp.Cli their own nuget.org READMEs in place of the root one.

Prompt summary: root and package READMEs share common branding and structure; package READMEs are valid for nuget.org; images where they show something off.

What

  • Root README.md follows standards/README.template.md: the cdp lockup (dark/light), tagline, one badge row (NuGet, CI, docs at cdp.nullean.net), a screenshot of a journey run, the existing intro and journey sample, install (library, journeys, CLI), quick start (the former "Use"), the Journeys, CLI and Finding Chrome sections unchanged, a packages table including @nullean/journeys, and "Learn more".
  • Directory.Build.props packed the root README into every package. It now packs $(MSBuildProjectDirectory)/README.md when it exists and falls back to the root README otherwise, the same pattern mermaider uses.
  • New src/Nullean.Cdp/README.md, src/Nullean.Cdp.Journeys/README.md and src/Nullean.Cdp.Cli/README.md. Their content comes from the root README sections, with absolute links and the lockup PNG from docs/images/brand/png.
  • New image docs/images/cdp-run.png (1460×800). It is a vhs screenshot of the cdp binary built from this branch: cat of a five-step journey, then cdp run search.journey --base-url http://localhost:8000/ against tests/Nullean.Cdp.Tests/site/index.html served locally, ending ok search.journey: 5 steps, 2 checkpoints. The journey was:
    # Search the fixture shop
    open index.html
    find label Search fill lamp
    uncheck "input[type=checkbox]"
    get value #q
    snapshot -c -s form
    
  • The C# quick starts now show the using lines they need. AxSnapshotOptions is in Nullean.Cdp.Accessibility, and Journey/JourneyRunner are in Nullean.Cdp.Journeys.

Verify

  • mise run pack, then scripts/check-package-readme.sh .artifacts/package-output/*.nupkg:
    Nullean.Cdp.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Journeys.0.11.1-alpha.0.1.nupkg: ok
    
  • mise run pack skips the CLI (CI packs it per RID as native AOT), so I packed it separately with dotnet pack src/Nullean.Cdp.Cli -c Release -o <scratch>:
    Nullean.Cdp.Cli.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Cli.any.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Cli.linux-arm64.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Cli.linux-x64.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Cli.osx-arm64.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Cli.win-arm64.0.11.1-alpha.0.1.nupkg: ok
    Nullean.Cdp.Cli.win-x64.0.11.1-alpha.0.1.nupkg: ok
    
    unzip -p confirms each package carries its own # <PackageId> README.
  • All 6 csharp blocks compiled in a scratch net10.0 project referencing src/Nullean.Cdp and src/Nullean.Cdp.Journeys. The only extras were stub page/browser fields for the fragments that use them. Mutating a snippet fails the build. The snippets were compiled, not run; the CLI run in the screenshot did drive Chrome.
  • CLI commands checked against cdp --help. Docs links return 200, and all three packages exist on nuget.org (0.11.0).
  • mise run check (curb + zizmor) passes.
  • Branch note: the local clone has a docs branch, so git can't create a local docs/... branch. I pushed the local branch readme-standard to docs/readme-standard.

🤖 Generated with Claude Code

The root README follows the shared template: lockup, tagline, one badge row (NuGet, CI, docs), a screenshot of a
journey run, install, quick start, the journeys, CLI and Chrome sections, a packages table and links.

All three packages packed the root README. Directory.Build.props now packs a project's own README.md when it has one
and falls back to the root otherwise. Nullean.Cdp, Nullean.Cdp.Journeys and Nullean.Cdp.Cli each get one written for
nuget.org.

docs/images/cdp-run.png is a vhs screenshot of the cdp CLI, built from this checkout, running a five-step journey
against the test fixture's index.html served on localhost. The C# quick starts now show the usings they need.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@Mpdreamz Mpdreamz added the documentation Documentation only (patch) label Nov 11, 2026
@Mpdreamz
Mpdreamz merged commit 867918d into main Nov 11, 2026
13 checks passed
@Mpdreamz
Mpdreamz deleted the docs/readme-standard branch November 11, 2026 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation only (patch)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant