docs(ui): describe this repository's frontend and keep its bundle out of local indexes - #305
Conversation
… of local indexes ui/README.md still described upstream's npm monorepo: a root `npm run build`, the `@colbymchenry/codegraph-ui` package and its publishing, and engine files under `src/`. It now covers `make ui` and `make ui-check`, the committed bundle the crate embeds, the Rust files behind the server and the engine, and what the Rust server does not send yet. The design sections keep upstream's text with paths, numbers and claims checked against this tree: the hierarchy's 26/28 px rows and indent, the Map's 44 px layer gap, the 14 required adapter methods, the `#/dead` and `#/steps` routes. UPSTREAM.md records the rewrite as a local layer. AGENTS.md now shows the local `.codegraph/config.toml` that keeps the minified bundle out of an index of this repository, where it adds about 3,300 symbols and pushes six of them into the top eight most-depended-on list.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5ddb5baf97
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| `make ui` output. Indexed, it adds about 3,300 symbols, nine in ten of them with | ||
| one- or two-letter names, that crowd the most-depended-on and entry-point lists, |
There was a problem hiding this comment.
Derive the viewer counts instead of freezing them
Whenever make ui rebuilds the minified bundle, both the symbol count and short-name ratio can change, but no source-contract test or documentation check derives or verifies these values—the only repository occurrence is this prose. Consequently the canonical contributor guide can silently retain obsolete evidence; either omit the numeric claims or derive and pin them in scripts/docs-check.py or a product test.
AGENTS.md reference: AGENTS.md:L134-L136
Useful? React with 👍 / 👎.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #305 +/- ##
=======================================
Coverage 95.05% 95.05%
=======================================
Files 197 197
Lines 108387 108387
=======================================
+ Hits 103023 103025 +2
+ Misses 5364 5362 -2 see 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
Summary
Two documentation follow-ups to the browser viewer (#298, #300).
ui/README.mdThe README was imported from upstream and still described upstream's npm monorepo. Wrong here:
npm run build,build:libanddist/viewer;@colbymchenry/codegraph-uipackage and its versioning and publishing;scripts/check-ui-*.mjs;src/.It now describes this repository:
make ui,make ui-check(the CIUIjob),npm run check,npm test, and the committed bundle the crate'sbuild.rsembeds. It also says plainly thatnpm run devhas no API behind it, with the two ways to work against a real index.GraphAdapter: 14 required methods includingscreens, withstepsoptional and left out ofcreateHttpAdapter. The shapes are thosecrates/codegraph-ui/src/api/serialises.find_dynamic_boundaries(crates/codegraph-ui/src/api/boundary.rs) runs explore'sscan_dynamic_dispatch. The hierarchy walk isbuild_type_hierarchy. Upstream'scountImplementersis not ported. The Rust index synthesizes no dispatch edges.HIER_ROW_H,HIER_INDENT).#/deadand#/steps.docs/upstream-sync/UPSTREAM.mdgains a dated entry recording the rewrite as a local layer. Existing entries are byte-identical.AGENTS.mdA short note in "Navigate with CodeGraph first" shows the local
.codegraph/config.tomlthat keeps the committed, minified bundle out of an index of this repository. Measured on an archive ofmain:With the exclusion, both lists are real code.
Verification
make fmt-checkandmake docs-checkpass (/tmp/evidence-tidy/docs-checks.log).ui/README.mdresolves.adapter.ts's interface;hierarchy-model.ts,map-model.tsandscreens-model.tsconstants;TopBar.svelte's "Not live";/api/trailsreadOnlyfield;countImplementersis not ported.ui/README.mdis not part of the build.🤖 Generated with Claude Code