Skip to content

Commit 961ecab

Browse files
authored
docs(FR-2116): clean up stale documentation in docs-toolkit and webui-docs (#5543)
1 parent 42f5110 commit 961ecab

12 files changed

Lines changed: 154 additions & 768 deletions

File tree

packages/backend.ai-docs-toolkit/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,10 @@ Generated files include a marker comment and can be customized after generation:
108108

109109
The PDF is generated through a multi-stage pipeline:
110110

111-
1. **Markdown Processing** — Parses `.md` files, extracts headings, resolves image paths, generates chapter-scoped heading IDs
111+
1. **Markdown Processing** — Parses `.md` files, extracts headings, resolves image paths, processes admonitions, generates chapter-scoped heading IDs
112112
2. **HTML Assembly** — Builds a single HTML document with cover page, TOC, and all chapters
113-
3. **PDF Rendering** — Multi-pass Playwright rendering with page number injection and header/footer
114-
4. **Post-processing**Header/footer masking on cover page via pdf-lib
113+
3. **PDF Rendering** — Multi-pass Playwright rendering with TOC page number injection and layout stabilization
114+
4. **Post-processing**pdf-lib stamps headers/footers on all pages, sets PDF metadata, and embeds CJK fonts
115115

116116
## Project Structure
117117

packages/backend.ai-webui-docs/MIGRATION-NOTES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# RST → Markdown Migration Notes
22

33
This document summarizes the RST → Markdown conversion applied to the `ko/` docs.
4-
Use it as a reference when applying the same work to other languages (`en/`, `ja/`, `zh-CN/`, `zh-TW/`).
4+
Use it as a reference when applying the same work to other languages (`en/`, `ja/`, `th/`).
55

66
**Delete this file after the migration is complete.**
77

@@ -166,15 +166,15 @@ The following should **not** be converted even if they use 3-space indentation:
166166
1. **`ko/` docs are the source of truth** — work on `ko/` first, then apply to other languages
167167
2. Each language has different sentence content, so use grep patterns (`^ \S`) to find candidates and apply the "What NOT to Convert" rules above
168168
3. Some languages may have standalone indented paragraphs not present in others (added/changed during translation)
169-
4. Sphinx metadata in `index.md` is likely present in all languages
169+
4. ~~Sphinx metadata in `index.md` is likely present in all languages~~**Done**: Sphinx metadata removed from `en/`, `ja/`, `th/` index.md files
170170
5. RST `|` remnants in `vfolder.md` may be ko-only, but verify for other languages
171171
6. RST tables (`===` separators) may also remain in other languages
172172

173173
## How to Instruct Claude
174174

175175
```
176176
Refer to @packages/backend.ai-webui-docs/MIGRATION-NOTES.md and apply the same
177-
conversion to en/ (or ja/, zh-CN/, zh-TW/) docs. Follow the same rules used for ko/:
177+
conversion to en/ (or ja/, th/) docs. Follow the same rules used for ko/:
178178
convert 3-space indented standalone paragraphs to :::info, and leave items that
179179
should not be converted (list continuations, etc.) as-is.
180180
```

packages/backend.ai-webui-docs/docs-review-report.md

Lines changed: 0 additions & 219 deletions
This file was deleted.

0 commit comments

Comments
 (0)