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: plan/step_1/README.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,18 +60,21 @@ This means files must physically move into separate directories — even for ste
60
60
Within a GitBook space, links use relative markdown paths. Between spaces, links must use absolute URLs (e.g., `https://docs.seam.co/api-reference/access_codes/create`). GitBook's broken link detection does not work across spaces.
61
61
62
62
Pages that will need link updates:
63
+
63
64
- Guides link heavily to API Reference endpoints (e.g., "see the `access_codes.create` endpoint")
64
65
- Brand Guides link back to Capability Guides (e.g., "see the Access Codes guide")
65
66
- API Reference links to Guides for conceptual context
66
67
67
68
### 3. Codegen pipeline needs updating
68
69
69
70
The current codegen (`npm run generate` → `codegen/smith.ts`) assumes a single `docs/` root:
71
+
70
72
-`summary.ts` splices generated API content into the single SUMMARY.md between anchors (`[Pagination]` and `## Developer Tools`)
71
73
-`postprocess.ts` converts absolute URLs to relative paths (assumes single-space structure)
72
74
- Generated files are written to `docs/api/`
73
75
74
76
For step 1, the codegen needs to:
77
+
75
78
- Write API files to `api-reference/` instead of `docs/api/`
76
79
- Generate a standalone SUMMARY.md for the API Reference space
77
80
- Update `postprocess.ts` to handle cross-space links (keep absolute URLs for links to Guides/Brand Guides)
@@ -81,6 +84,7 @@ For step 1, the codegen needs to:
81
84
GitBook spaces cannot share assets. Currently all images live in `docs/.gitbook/assets/` and reusable snippets in `docs/.gitbook/includes/`. Each space would need its own copy of any shared assets.
82
85
83
86
Options:
87
+
84
88
- Duplicate assets into each space that uses them
85
89
- Use a build step to copy shared assets into each space directory
86
90
- Audit which assets are used by which section and split accordingly
@@ -92,6 +96,7 @@ Sandbox pages are currently scattered across `device-guides/sandbox-and-sample-d
92
96
### 6. Files referenced across sections
93
97
94
98
Some files currently live in one directory but are listed in a different sidebar section:
99
+
95
100
-`device-guides/reconnecting-an-account.md` is listed under Core Concepts > Connected Accounts
96
101
-`device-guides/rate-limits-and-guardrails.md` is listed under Developer Tools
97
102
- Various `products/` files appear in Capability Guides
0 commit comments