Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/code-navigation/precise-code-navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,12 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc
## Setting up code navigation for your codebase

<Callout type="info">
There are several options for setting up precise code navigation listed
below. However, we always recommend you start by manually indexing your repo
locally using the [approriate
indexer](/code-navigation/writing-an-indexer#quick-reference) for your
language. Code and build systems can vary by project and ensuring you can
first succesfully run the indexer locally leads to a smoother experience
since it is vastly easier to debug and iterate on any issues locally before
trying to do so in CI/CD or in Auto-Indexing.
Auto-indexing is a fast way to get started, but for complex or
authenticated builds we recommend [running SCIP indexing in your CI
pipeline](/code-navigation/how-to/adding-scip-to-workflows). This reuses
your existing build configuration and secrets, delivering more reliable,
repeatable precise code navigation. For best results, verify the indexer
runs successfully on your machine first, then add it as a CI job.
</Callout>

1. **Manual indexing**. Index a repository and upload it to your Sourcegraph instance:
Expand Down