Skip to content

Commit 3c4abe6

Browse files
docs: move CodeGraph setup section to contributing guide
Addresses review feedback that this belongs in docs/contributing.md rather than the README.
1 parent d921e42 commit 3c4abe6

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,3 @@ This is an Appium driver for automating native and hybrid applications on iOS, i
3333
## Documentation
3434

3535
You can access the documentation here: [**https://appium.github.io/appium-xcuitest-driver**](https://appium.github.io/appium-xcuitest-driver)
36-
37-
### Optional: CodeGraph for local code navigation
38-
39-
If you want a local semantic index for this repository, you can install [CodeGraph](https://github.com/colbymchenry/codegraph) locally and initialize it in the repo:
40-
41-
```bash
42-
curl -fsSL https://raw.githubusercontent.com/colbymchenry/codegraph/v1.5.0/install.sh | sh
43-
cd "<project folder>"
44-
codegraph install
45-
codegraph init
46-
```
47-
48-
CodeGraph builds a local knowledge graph of symbols and call paths so AI coding agents, like Cursor or Claude, can answer questions and navigate the codebase faster with fewer file reads and reduced token consumption.

docs/contributing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,16 @@ the tests locally. These include:
4343
the root directory of the repo with the extension `.xcconfig`)
4444
* `UICATALOG_REAL_DEVICE` - path to the real device build of UICatalog, in case
4545
the `npm` installed one is not built for a real device
46+
47+
### Optional: CodeGraph for local code navigation
48+
49+
If you want a local semantic index for this repository, you can install [CodeGraph](https://github.com/colbymchenry/codegraph) locally and initialize it in the repo:
50+
51+
```bash
52+
curl -fsSL https://raw.githubusercontent.com/colbymchenry/codegraph/v1.5.0/install.sh | sh
53+
cd "<project folder>"
54+
codegraph install
55+
codegraph init
56+
```
57+
58+
CodeGraph builds a local knowledge graph of symbols and call paths so AI coding agents, like Cursor or Claude, can answer questions and navigate the codebase faster with fewer file reads and reduced token consumption.

0 commit comments

Comments
 (0)