chore(release): 0.7.5 — README refresh and docs-site links#20
Merged
Conversation
Drop the 'Not released' banner and the 'Implementation status' section now that 0.7.4 is on npm. Compress the motivation to a single paragraph and make https://dimdasci.github.io/bproxy/ the most prominent line, since the docs site is the canonical surface for design principles, architecture, install, and CLI usage. Reorganise the body into two task-oriented sections (For users, For developers), each linking into the published site rather than into raw docs/ paths in the repository. Note the current reality honestly: CLI and daemon install from npm; the extension is a manual unpacked install pending a Chrome Web Store listing. Remove the existing browser-proxy-idea.png figure and leave a TODO marker where its replacement will go; the illustration redesign lands in a follow-up commit on this branch.
The hero illustration explored in this branch's planning didn't reach shippable quality with the available image-gen tooling — a real illustrator is the right call when we revisit. Drop the placeholder TODO comment from README and remove the now-orphan docs/internal/browser-proxy-idea.png so the repo doesn't carry an unreferenced asset. Architecture is still conveyed by the ASCII flow line in the README and by the C4 Containers view on the published docs site.
Picks up the docs/README housekeeping landed in this branch and the GitHub Pages publishing changes from #19 (homepage and bugs fields in the published npm package, README link to the docs site instead of raw GitHub markdown). Tag v0.7.5 after merge to trigger the release workflow. Run via: node scripts/sync-versions.js && node scripts/check-versions.js
Replace the small cable.svg favicon-icon block at the top of the README with the new hero illustration at assets/bproxy-hero.png. The image conveys the system shape — agents on the left, CLI terminal in the middle, daemon as a shield enforcing scope, browser tabs on the right — framed inside a monitor so the viewer occupies the human-in-the-loop seat. Carries an embedded caption: 'bproxy: paired browsing for humans and agents'. The cable.svg remains the docs site logo (configured in views/astro.config.mjs); it is no longer needed in the README itself because the hero image is now the README's visual identity. Width attribute caps the rendered image at 900px so it does not exceed GitHub's content column on wide screens. Alt text describes both the visual and the embedded caption for screen-reader accessibility.
|
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
1 participant
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.
Housekeeping release picking up two threads:
What
224af0e) — drop the 'Not released' banner now that 0.7.4 is on npm; compress the motivation; make https://dimdasci.github.io/bproxy/ the most prominent line; reorganise into 'For users' and 'For developers' sections that link into the published docs site. The README is intentionally a pointer; the docs site is the canonical surface.1b18899) —docs/internal/browser-proxy-idea.pngwas no longer referenced anywhere; image-gen explorations on this branch did not reach shippable quality and a real illustrator is the right call when we revisit. Architecture is still conveyed by the ASCII flow line in the README and the C4 Containers view in the docs site.2d1893a) — propagated viascripts/sync-versions.js(workspace package.jsons,shared/src/version.ts,skills/bproxy/SKILL.md);scripts/check-versions.jsconfirms parity. Taggingv0.7.5onmainafter merge will trigger the release workflow and publish the npm metadata fixes from feat(docs): publish public docs to GitHub Pages #19 (homepage, bugs, README deep-links) to the registry.Verification
pnpm checkandpnpm testboth green locally on this branch.Post-merge steps
That triggers
.github/workflows/release.yml: builds the release package, runs the smoke test, publishes to npm with the corrected metadata, attaches the extension zip to the GitHub Release.