Skip to content

Commit 483f4fe

Browse files
seambotlouis-pre
authored andcommitted
ci: Format code
1 parent 39415ef commit 483f4fe

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

plan/step_1/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,21 @@ This means files must physically move into separate directories — even for ste
6060
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.
6161

6262
Pages that will need link updates:
63+
6364
- Guides link heavily to API Reference endpoints (e.g., "see the `access_codes.create` endpoint")
6465
- Brand Guides link back to Capability Guides (e.g., "see the Access Codes guide")
6566
- API Reference links to Guides for conceptual context
6667

6768
### 3. Codegen pipeline needs updating
6869

6970
The current codegen (`npm run generate``codegen/smith.ts`) assumes a single `docs/` root:
71+
7072
- `summary.ts` splices generated API content into the single SUMMARY.md between anchors (`[Pagination]` and `## Developer Tools`)
7173
- `postprocess.ts` converts absolute URLs to relative paths (assumes single-space structure)
7274
- Generated files are written to `docs/api/`
7375

7476
For step 1, the codegen needs to:
77+
7578
- Write API files to `api-reference/` instead of `docs/api/`
7679
- Generate a standalone SUMMARY.md for the API Reference space
7780
- 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:
8184
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.
8285

8386
Options:
87+
8488
- Duplicate assets into each space that uses them
8589
- Use a build step to copy shared assets into each space directory
8690
- 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
9296
### 6. Files referenced across sections
9397

9498
Some files currently live in one directory but are listed in a different sidebar section:
99+
95100
- `device-guides/reconnecting-an-account.md` is listed under Core Concepts > Connected Accounts
96101
- `device-guides/rate-limits-and-guardrails.md` is listed under Developer Tools
97102
- Various `products/` files appear in Capability Guides

0 commit comments

Comments
 (0)