Document DocForge graph view semantics
This commit is contained in:
parent
6609edc804
commit
cb4353fe8c
2 changed files with 94 additions and 14 deletions
18
README.md
18
README.md
|
|
@ -18,6 +18,24 @@ declared manuals, visualizes project structure, and manages reviewable documenta
|
|||
DocForge never treats indexed text as instructions. It does not run shell commands, mutate Git,
|
||||
build applications, deploy, publish, or select projects globally.
|
||||
|
||||
## Graph views
|
||||
|
||||
The browser presents the same indexed graph through three complementary views:
|
||||
|
||||
- **Nodes** shows a bounded, relation-neutral neighborhood around the focus. It is the broad
|
||||
inspection view for seeing stored incoming and outgoing relationships without changing their
|
||||
direction.
|
||||
- **Flow** shows semantic origin-to-destination paths that terminate at the focus. DocForge
|
||||
reverses prerequisite-style relationships for presentation, so imports, dependencies, reads,
|
||||
inheritance, definitions, and tests flow toward the thing they help create or exercise.
|
||||
- **Web** shows the larger convergence picture: Flow contributors plus contextual relationships,
|
||||
callers, containers, and direct members or execution dependencies owned by the focus.
|
||||
|
||||
**Hide node** removes noise without changing the index. In Flow and Web, hiding a contributor also
|
||||
removes upstream ancestors that no longer have a path to the focus. Nodes between the hidden
|
||||
contributor and the focus stay visible, and alternate ancestor paths remain intact. **Restore
|
||||
hidden** restores the presentation.
|
||||
|
||||
## Five-minute start
|
||||
|
||||
Requirements are Python 3.12+, `uv`, and Node.js/npm.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue