docs: stop presenting codegraph ui as a released command - #1680
Open
gac0812 wants to merge 1 commit into
Open
Conversation
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.
Summary
The
codegraph uiviewer is a really excellent feature — callers, source, and callees on one screen is exactly the kind of thing that makes the graph readable for humans, not just agents. I ran into this while using CodeGraph: the README told me to runcodegraph ui, but the latest release (v1.6.0) does not have that command.#1666 already calls this out, and you noted it should not have shown up in the README yet. I still think the README itself should say so, so the next person who follows the getting-started steps is not sent to a command that is not on the published CLI.
This PR:
codegraph uistep from the README and drops it from the released CLI listmain/ the next release, not v1.6.0If a release that actually ships
codegraph uilands first and this PR is still open, please close it — the warnings would then be wrong.Related to #1666