docs: add logo and update README for the v2 global model#20
Merged
Conversation
Adds the Sentiness logo under docs/assets/ and renders it at the top of the README. Refreshes the README to describe the v2 architecture the project is moving to: a global launcher (@sentiness/cli) with a version-pinned engine and checks resolved into a global cache, projects with zero node_modules committing only sentiness.config.json + sentiness.lock + baseline + agent files. Updates the onboarding flow (npm i -g @sentiness/cli -> init -> install -> check), the command table (adds `sentiness install` / `--frozen`), and the configuration section to the v2 schema (engine pin, catalog entries declaring version/path, optional zones[] for polyglot monorepos). Also lists the ESLint and Playwright checks that were missing from the implemented-checks summary.
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.
Stacked on #19 (
feat/init-v2-zones). Documentation only — no code changes.Change
docs/assets/sentiness.pngand renders it centered at the top of the README.@sentiness/cli, version-pinned engine + checks in a global cache, projects with zeronode_modulescommitting onlysentiness.config.json+sentiness.lock+ baseline + agent files):npm i -g @sentiness/cli→init→install→check.sentiness install(+--frozenfor CI).enginepin, catalog entries declaring exactly one ofversion/path, and an optionalzones[]example for polyglot monorepos.Why stacked (not off main)
The README now describes the v2 model, which only becomes true once this stack (#17 → #18 → #19) lands. Basing it on
mainwould make the README describe behavior not yet onmain. It is the last PR in the stack and merges after #19.Note
The "Quick Start In This Checkout" commands are unchanged (verified working against this repo's dogfood config). No linter covers Markdown;
pnpm lintstays green.