Repository navigation
Give the README and package READMEs the shared nullean shape - #54
Merged
Merged
Conversation
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]>
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
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.
Gives the root README the shared nullean structure, and gives
Nullean.Cdp,Nullean.Cdp.JourneysandNullean.Cdp.Clitheir 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
README.mdfollowsstandards/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.propspacked the root README into every package. It now packs$(MSBuildProjectDirectory)/README.mdwhen it exists and falls back to the root README otherwise, the same pattern mermaider uses.src/Nullean.Cdp/README.md,src/Nullean.Cdp.Journeys/README.mdandsrc/Nullean.Cdp.Cli/README.md. Their content comes from the root README sections, with absolute links and the lockup PNG fromdocs/images/brand/png.docs/images/cdp-run.png(1460×800). It is a vhs screenshot of thecdpbinary built from this branch:catof a five-step journey, thencdp run search.journey --base-url http://localhost:8000/againsttests/Nullean.Cdp.Tests/site/index.htmlserved locally, endingok search.journey: 5 steps, 2 checkpoints. The journey was:usinglines they need.AxSnapshotOptionsis inNullean.Cdp.Accessibility, andJourney/JourneyRunnerare inNullean.Cdp.Journeys.Verify
mise run pack, thenscripts/check-package-readme.sh .artifacts/package-output/*.nupkg:mise run packskips the CLI (CI packs it per RID as native AOT), so I packed it separately withdotnet pack src/Nullean.Cdp.Cli -c Release -o <scratch>:unzip -pconfirms each package carries its own# <PackageId>README.csharpblocks compiled in a scratch net10.0 project referencingsrc/Nullean.Cdpandsrc/Nullean.Cdp.Journeys. The only extras were stubpage/browserfields 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.cdp --help. Docs links return 200, and all three packages exist on nuget.org (0.11.0).mise run check(curb + zizmor) passes.docsbranch, so git can't create a localdocs/...branch. I pushed the local branchreadme-standardtodocs/readme-standard.🤖 Generated with Claude Code