Repository navigation
docs: add the form-builder README header from the design system - #5
Merged
Merged
Conversation
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.
Intent
Put the Whatsaaaa assets from the design system in every project's README. For this repository, which holds form-builder's sample apps and its release trial: form-builder's README header from the design system's asset kit, copied in unchanged, at the top of the README; the rest of the README stays as it is.
What Changed
.github/assets/readme-header.svg, the form-builder README header from the Whatsaaaa design system's asset kit.README.md, above the# form-builder-sampleheading. It is shown at full width, with alt text "form-builder - forms from JSON, validated by Formisch".🤖 Generated with Claude Code
Risk Assessment
✅ Low: The change only adds an unedited, byte-identical design-system SVG and one img line at the top of the README, matching the design system's own README convention; the only open point is which identity's header this sample repo should carry.
Testing
I checked the committed header SVG against the published
@whatsaaaa/design-system@0.1.1npm tarball: it is byte-identical, listed in the manifest as "Header for a README", and its path resolves case-sensitively in the committed tree. I then put README.md through GitHub's real GFM renderer and screenshotted it in headless Chromium in light and dark themes at desktop and mobile widths, plus a broken-image case. Every time, the header is the first element, scales to the content width with no cropping, and falls back to its alt text. All six live scenarios passed. Viewing the README on github.com itself was not possible, because the branch is not pushed yet and the repo is private; the later PR phase owns the push.form-builder-sampleheadingEvidence: Asset identity vs npm @whatsaaaa/design-system@0.1.1, manifest entry, case-sensitive path resolution, img-sandbox safety
src=./.github/assets/readme-header.svg (first element of rendered README) git ls-tree b32c3fb: 100644 blob 4c7a977f .github/assets/readme-header.svg sha256 committed blob = sha256 npm package/assets/form-builder/readme-header.svg = 276684914a9798c0983cc204c75a6c0adc99b0b97dd4ac45986481d6426601f2 RESULT: byte-identical (unedited copy) manifest: form-builder readme-header.svg 1280x320 'Header for a README.' script/foreignObject/@import/font-face/<text>/external href: 0Evidence: README HTML as emitted by GitHub's GFM renderer (POST /markdown)
Pipeline
Updates from git push no-mistakes
✅ **Intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
README.md:1- The README header is form-builder's kit (assets/form-builder/readme-header.svg, identical to design-system main and npm 0.1.1), not a kit for this repo. Rendered, it showswhatsaaaa: ~/form-builder,form-builder --helpand a large "form-builder", directly above the# form-builder-sampleheading, so the header names a different repository. The intent counts this repo as one of "all our projects". The usage guide it cites (docs/usage.md section 9) says: "For a project that has no kit yet, add a file likeidentity/projects/form-builder.jsonfirst." The manifest has kits only for whatsaaaa, building-blocks, dotfiles and form-builder, with none for form-builder-sample. Borrowing form-builder's kit is defensible because this repo is form-builder's 1.0 trial, but it is a branding decision. Options: (a) keep form-builder's header, (b) use thewhatsaaaahandle header, or (c) addidentity/projects/form-builder-sample.jsonin the design-system repo, runpnpm assets, and copy that header here. The remedy (option c) needs work outside this repo, which is why this needs your decision rather than an auto-fix. The same choice applies to the copied asset at .github/assets/readme-header.svg:1 and the alt text at README.md:1 ("form-builder - forms from JSON, validated by Formisch").✅ **Test** - passed
✅ No issues found.
form-builder-sampleheadingnpm pack @whatsaaaa/design-system@latest(0.1.1) into the evidence dir, extracted, readassets/manifest.jsonanddocs/usage.mdsection 9git show b32c3fb:.github/assets/readme-header.svg | cmp - package/assets/form-builder/readme-header.svgplus sha256 of both (identical: 276684914a97...)git ls-tree b32c3fb -- .github/assets/readme-header.svgusing the exact img src that GitHub's renderer emitted (case-sensitive path lookup)Checked the SVG for things an <img> sandbox blocks (script, foreignObject, @import, font-face, <text>, external hrefs): none present, text is outlined as pathsgh api -X POST /markdown -f mode=gfm -f context=whatsaaaa/form-builder-sample -F text=@README.md(GitHub's real GFM renderer and sanitizer) -> render/readme-github-gfm.htmlServed the worktree read-only and the rendered page with github-markdown-css 5.9.0 on 127.0.0.1, screenshotted with Playwright's cached chrome-headless-shell at 1280x900 (light, dark) and 390x844 @2x (light, dark)Adversarial: same page with the header unreachable (base pointed at a dead port), screenshotted to show the alt-text fallbackgit ls-files | grep -i readmeto confirm README.md is the only README in the repoStopped both local servers and removed the temp browser profiles;git status --porcelainis empty✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.