mirror of
https://github.com/safishamsi/graphify.git
synced 2026-10-16 08:59:26 +00:00
docs: clarify repository orientation and team graph sync rules
(cherry picked from commit 9d2592ea50)
This commit is contained in:
1 parent
c973b90dea
commit
98d73fe3a8
2 files changed
+10
-6
No files matched your search
@@ -3,6 +3,6 @@
|
||||
This project has a graphify knowledge graph at graphify-out/.
|
||||
|
||||
Rules:
|
||||
- Before answering architecture or codebase questions, read graphify-out/GRAPH_REPORT.md for god nodes and community structure
|
||||
- When working on Graphify itself, use the repository's existing Graphify guidance. For codebase questions, prefer scoped graph queries where available; use the report for broad orientation. Do not use the graph as evidence when the task concerns the graph's correctness itself.
|
||||
- If graphify-out/wiki/index.md exists, navigate it instead of reading raw files
|
||||
- After modifying code files in this session, run `graphify update .` to keep the graph current (AST-only, no API cost)
|
||||
@@ -446,12 +446,16 @@ dist/
|
||||
|
||||
## Team setup
|
||||
|
||||
`graphify-out/` is meant to be committed to git so everyone on the team starts with a map.
|
||||
For users building a team graph, the `graphify-out/` directory is gitignored by default. If your team wants to share a graph, you should **explicitly force-add only the queryable products** so your teammates can consume them:
|
||||
|
||||
**Recommended `.gitignore` additions:**
|
||||
```
|
||||
graphify-out/cost.json # local only
|
||||
# graphify-out/cache/ # optional: commit for speed, skip to keep repo small
|
||||
*(Note: If you are contributing to the Graphify repository itself, do not commit your local `graphify-out/` at all unless it's a specific test fixture).*
|
||||
|
||||
**Recommended git commands to share a graph (you only need to force-add once; git will track future changes normally):**
|
||||
```bash
|
||||
git add -f graphify-out/graph.json
|
||||
git add -f graphify-out/GRAPH_REPORT.md
|
||||
# git add -f graphify-out/wiki/ # optional: if using the wiki export
|
||||
# git add -f graphify-out/obsidian/ # optional: if using the Obsidian export
|
||||
```
|
||||
|
||||
> `manifest.json` is now portable — keys are stored as relative paths and re-anchored on load, so committing it is safe and avoids a full rebuild on first checkout.
|
||||
|
||||
Reference in new issue
Block a user