You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content-indexer/README.md
+24-15Lines changed: 24 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
Content Indexer is the indexing system that builds path indexes, navigation trees, and Algolia search records for the Alchemy docs site. It lives in the `docs` repository and processes documentation from three sources:
4
4
5
5
1.**Main Docs** - Manual content from `docs/fern/docs.yml` (local filesystem)
6
-
2.**SDK References** - Generated content from `aa-sdk/docs/docs.yml` (GitHub API)
6
+
2.**SDK References** - Generated content from `aa-sdk/docs/docs.yml` (sparse checkout in GHA)
7
7
3.**Changelog** - Entries from `docs/fern/changelog/*.md` (local filesystem)
8
8
9
9
## Three Indexers
@@ -28,8 +28,8 @@ Indexes manual documentation content from the local `docs` repository.
28
28
29
29
Indexes SDK reference documentation from the `aa-sdk` repository.
30
30
31
-
***Trigger**: Changes to `aa-sdk/docs/docs.yml`
32
-
***Source**: GitHub API (aa-sdk repo)
31
+
***Trigger**: Changes to `aa-sdk/docs/docs.yml` via repository dispatch
32
+
***Source**: Local filesystem (sparse checkout of aa-sdk/docs in GHA)
33
33
***Updates**:
34
34
*`{branch}/path-index:sdk` (Redis)
35
35
*`{branch}/nav-tree:wallets` (Redis, merged with existing manual content)
@@ -112,7 +112,7 @@ flowchart TD
112
112
**Key difference between main and SDK:**
113
113
114
114
***Main**: Reads from local filesystem (`docs/fern/`)
115
-
***SDK**: Fetches from GitHub API (`aa-sdk/docs/`)
115
+
***SDK**: Reads from local filesystem (`aa-sdk-docs/docs/`) after sparse checkout in GHA
116
116
117
117
### Changelog Indexer: Simpler Flow
118
118
@@ -320,7 +320,6 @@ content-indexer/
320
320
│ └── redis.ts # Stores to Redis with branch scoping
321
321
├── utils/ # Utility functions
322
322
│ ├── filesystem.ts # Local file reading utilities
323
-
│ ├── github.ts # GitHub API utilities
324
323
│ ├── nav-tree-merge.ts # Wallets nav tree merging logic
0 commit comments