Skip to content

Commit 92ef961

Browse files
feat: add pip package documentation to the README and Docs pages
1 parent a84839c commit 92ef961

3 files changed

Lines changed: 15 additions & 7 deletions

File tree

renderwise-forge-main/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ Each example folder contains `file_tree.json`, `dep_graph.json`, and `dgat_bluep
5959

6060
## Docs
6161

62-
- [Overview](src/docs/overview.md) — how DGAT works end to end
63-
- [File Tree](src/docs/file-tree.md) — TreeNode structure, fields, and why each one exists
64-
- [Dependency Graph](src/docs/dependency-graph.md) — DepNode, DepEdge, DepGraph, and how the graph is built
65-
- [Incremental Updates](src/docs/incremental-updates.md) — how the diff mode works with XXH3 fingerprints
66-
- [Import Extraction](src/docs/import-extraction.md) — tree-sitter parsing, regex fallbacks, and path resolution
67-
- [Python Package](src/docs/pip-package.md) — installing and using DGAT as a pip package
62+
- [Overview](docs/overview.md) — how DGAT works end to end
63+
- [File Tree](docs/file-tree.md) — TreeNode structure, fields, and why each one exists
64+
- [Dependency Graph](docs/dependency-graph.md) — DepNode, DepEdge, DepGraph, and how the graph is built
65+
- [Incremental Updates](docs/incremental-updates.md) — how the diff mode works with XXH3 fingerprints
66+
- [Import Extraction](docs/import-extraction.md) — tree-sitter parsing, regex fallbacks, and path resolution
67+
- [Python Package](docs/pip-package.md) — installing and using DGAT as a pip package

renderwise-forge-main/src/pages/DocsDetailPage.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ import dependencyGraphContent from "@/docs/dependency-graph.md?raw";
66
import fileTreeContent from "@/docs/file-tree.md?raw";
77
import importExtractionContent from "@/docs/import-extraction.md?raw";
88
import incrementalUpdatesContent from "@/docs/incremental-updates.md?raw";
9+
import pipPackageContent from "@/docs/pip-package.md?raw";
910

1011
const DOC_CONTENT: Record<string, string> = {
1112
overview: overviewContent,
1213
"dependency-graph": dependencyGraphContent,
1314
"file-tree": fileTreeContent,
1415
"import-extraction": importExtractionContent,
1516
"incremental-updates": incrementalUpdatesContent,
17+
"pip-package": pipPackageContent,
1618
};
1719

1820
const DOC_NAMES: Record<string, string> = {
@@ -21,6 +23,7 @@ const DOC_NAMES: Record<string, string> = {
2123
"file-tree": "File Tree",
2224
"import-extraction": "Import Extraction",
2325
"incremental-updates": "Incremental Updates",
26+
"pip-package": "Pip Package",
2427
};
2528

2629
export default function DocsDetailPage() {

renderwise-forge-main/src/pages/DocsPage.tsx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import dependencyGraphContent from "@/docs/dependency-graph.md?raw";
55
import fileTreeContent from "@/docs/file-tree.md?raw";
66
import importExtractionContent from "@/docs/import-extraction.md?raw";
77
import incrementalUpdatesContent from "@/docs/incremental-updates.md?raw";
8+
import pipPackageContent from "@/docs/pip-package.md?raw";
89

910
interface DocInfo {
1011
id: string;
@@ -48,7 +49,11 @@ const DOCS: DocInfo[] = [
4849
id: "incremental-updates",
4950
name: "Incremental Updates",
5051
description: extractDescription(incrementalUpdatesContent),
51-
},
52+
}, {
53+
id: "pip-package",
54+
name: "Pip Package",
55+
description: extractDescription(pipPackageContent),
56+
}
5257
];
5358

5459
export default function DocsPage() {

0 commit comments

Comments
 (0)