Repository navigation
docs: make the README easier to follow for new users - #44
Merged
Merged
Conversation
Epsirom
added a commit
that referenced
this pull request
Oct 4, 2026
## Change Prepare Braid 0.3.1 with matching versions of core, Pi, and the new DeepSeek Harness integration. DSH users gain background graphs and a native Web panel from #45; existing core and Pi contracts are preserved. Include README onboarding improvements from #44, credit both PRs to @Epsirom, and verify that neither introduces a first-time contributor. Update all manifests, exact core dependencies, and the workspace lockfile. Add npm installation instructions and badges for DSH, record the DSH 0.2.0-rc.2 / Node 22.19+ baseline, and align compatibility, roadmap, and registry documentation. Record the repository description and topics that will be applied after publication, including DeepSeek Harness support. No runtime code changes or migration from 0.3.0. ## Validation - `npm ci` and `npm run verify` passed: 227 core, 90 Pi, and 35 DSH tests; type checks, offline examples, and clean tarball consumers including public ESM imports, declarations, background jobs, and the DSH browser entry. - `npm run audit:dependencies` passed with no known vulnerabilities, including development dependencies. - `RELEASE_TAG=v0.3.1 node scripts/check-release.mjs` and `git diff --check` passed. - Inspected `npm pack --dry-run` for all three packages; licenses and expected compiled files are present, without test files or checkout dependencies. - Verify the required Node/platform CI matrix before tagging and publishing. DSH requires first publication and npm authentication before trusted publishing can be configured. - [x] Relevant tests and type checks pass. - [x] User-facing docs and changelog are updated. - [x] No existing API breaking changes; no migration required. - [x] Release notes link implementing PRs, credit authors, and verify first-time contributor status.
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.
Change
New readers had to scan release history, migration guidance, and execution details before learning what Braid does. Lead with a plain-language introduction and a three-node code-review example, then offer application and Pi installation paths. Move release and upgrade links to the end and source development setup below the usage reference.
Add an Unreleased documentation entry to the changelog.
Validation
git diff --checkpassed.Checked all 36 local README links and heading anchors.
Runtime tests and type checks were not run because this only changes documentation.
Relevant validation passes; runtime tests and type checks are not applicable to this documentation-only change.
User-facing docs and changelog are updated.
No breaking changes; existing migration guidance remains linked.
Release notes and contributor credit requirements are not applicable; this is not a release PR.