Repository navigation
docs: position codeshot as the docs-and-CI layer for CodeGraph; v0.3.0 - #50
Merged
Merged
Conversation
CodeGraph is growing an interactive viewer (`codegraph ui`, on upstream main, not yet released), which covers ad-hoc exploration of one symbol's trail. Lead the README with what a viewer can't do: committed diagrams kept honest by --embed/--check, --forbid architecture rules, and --diff for PR review. - New intro: three-job table, GitHub Actions example, "why" vs on-demand tools - Reorder modes: architecture, diff, single-symbol trail - Split the old Usage list into symbol-only flags and flags shared by every mode - Design decisions: standalone-tool rationale now reflects the viewer
- CI example: explicit --out, one combined --check --forbid scan, pinned actions/codegraph/codeshot; no longer claims to match ci.yml exactly - Say committed diagrams need CI's codegraph build and Node line, and when --limit is ignored (Node 22.5+ direct index read) and its fallbacks - Design decision now describes the direct index read; viewer claims hedged as unreleased - USAGE/TECHNICAL: --out in embed/check examples, default filename caveat, depth-flag rejection only when non-default; package description - Version 0.3.0 so the README can pin #v0.3.0 (first tag with --forbid)
inth3shadows
changed the title
This was referenced Oct 16, 2026
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.
Why
CodeGraph is building an interactive viewer (
codegraph ui: on upstreammain, gated and not in any release yet). It covers ad-hoc exploration of one symbol's trail. The README now leads with what a viewer can't do: committed diagrams that CI keeps honest.What changed
--embed --check,--forbid,--diff), and a GitHub Actions example that runs--checkand--forbidin one scan. The example pins the actions by SHA,@colbymchenry/codegraph@1.6.0andcodeshot#v0.3.0, and passes an explicit--out.--limitis ignored by the Node 22.5+ direct index read, and the README now lists when codeshot falls back to the CLI.--embedfilename includes the checkout directory, so always pass--out.--depth/--max-depth-nodesare rejected only when not left at their defaults.Release
After merge, tag
v0.3.0on the merge commit.release.ymlpublishes it, and the README's#v0.3.0pin resolves. v0.2.0 predates--forbid.Verification
npm test:195 passed, 0 failed.--check --forbidexit 0.test/->render/.Follow-ups (to file)
--embedfilename includes the checkout directory (the code fix, rather than the doc workaround).