diff --git a/docs/scip-ruby/CLI.md b/docs/scip-ruby/CLI.md index 4d3132de5..b3d50a7fc 100644 --- a/docs/scip-ruby/CLI.md +++ b/docs/scip-ruby/CLI.md @@ -22,10 +22,14 @@ instead (`git rev-parse HEAD`). ## `--gem-map-path ` -At the moment, scip-ruby requires an extra step for cross-repo -code navigation; you need to supply information about which -file belongs to which gem explicitly, using a newline-delimited -JSON file in the following format: +For cross-repo navigation, scip-ruby needs to know which files +belong to which gem. By default, scip-ruby will attempt to +infer this from filepaths, assuming that files under `sorbet/rbi/{gems,annotations,dsl}/` +belong to external gems as per the [standard layout](https://sorbet.org/docs/rbi#quickref). + +If you have files that contain definitions belonging to other gems, +but are placed in non-standard directories, you can specify the correct gem information +using a newline-delimited JSON file in the following format: