docs: clarify the installer already inits the current project (#826)#883
Open
Dashsoap wants to merge 1 commit into
Open
docs: clarify the installer already inits the current project (#826)#883Dashsoap wants to merge 1 commit into
Dashsoap wants to merge 1 commit into
Conversation
…olbymchenry#826) The Quick Start lists 'codegraph init' as step 3 as if it were always required, but step 1's installer already initializes the project it's run in (src/installer/index.ts initializeLocalProject -> CodeGraph.init + indexAll on a local install). Users who follow the steps literally hit 'Already initialized ...' when they re-run init in that same project (reported in colbymchenry#826). Clarify that step 3's 'codegraph init' is for OTHER projects, and that the project the installer ran in is already indexed.
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.
Fixes #826.
What
The Quick Start lists
codegraph initas step 3 as if it were always required after install. This clarifies that the interactive installer already initializes the project it is run in, so step 3 only applies to other projects.Why
Step 1 of the same Quick Start already documents that the installer will:
This is real —
src/installer/index.tsrunsinitializeLocalProject()on a local install, which callsCodeGraph.init()+indexAll():So a user who follows the steps literally runs
codegraph init(step 3) in the same project the installer just initialized, and gets:That is exactly what the reporter hit in #826. This is a docs-only clarification:
No code change.