docs(FR-2912): document web commands and fix preview:html sidebar scroll#7462
Conversation
This was referenced May 18, 2026
This was referenced May 18, 2026
5 tasks
Contributor
Author
agatha197
changed the title
agatha197
force-pushed
the
05-16-docs_misc_document_re-login_required_notification_after_main_keypair_change
branch
from
3e737ea to
f5d41b7
Compare
agatha197
force-pushed
the
05-18-docs_fr-2912_document_docs-toolkit_build_web_and_serve_web_commands_in_readme
branch
from
e4af0ea to
d7272a8
Compare
FR-2768 made .doc-sidebar a fixed-height, overflow:hidden flex column and delegated scrolling to an inner .doc-sidebar__scroll element in styles-web.ts. website-builder.ts (build:web / serve:web) emits that wrapper, but the legacy single-page preview builder (html-builder-web.ts, used by preview:html / preview:html:ko) was never updated, so the nav overflowed a clipped container with no scrollport and the sidebar could not scroll. Wrap the nav list in .doc-sidebar__scroll to mirror website-builder.ts, restoring sidebar scrolling in the HTML preview server. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…README New clones / git worktrees run `pnpm install` before the toolkit's `dist/cli.js` exists, so pnpm skips creating the `docs-toolkit` bin symlink and every `docs-toolkit ...` script fails with `not found`. Document the cause and the `pnpm --filter <docs-pkg> rebuild` fix (since `pnpm install`/`--force` report "Already up to date" and skip bin-linking). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
agatha197
force-pushed
the
05-16-docs_misc_document_re-login_required_notification_after_main_keypair_change
branch
from
f5d41b7 to
e775331
Compare
agatha197
force-pushed
the
05-18-docs_fr-2912_document_docs-toolkit_build_web_and_serve_web_commands_in_readme
branch
from
d7272a8 to
2755b1a
Compare
3 tasks
5 tasks
This was referenced May 18, 2026
agatha197
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Backend.AI docs toolkit documentation for static website commands and related troubleshooting, while also including a small generated HTML structure change for the web preview sidebar.
Changes:
- Documents
build:web,serve:web, common CLI options, default ports, and troubleshooting for missingdocs-toolkitbin links. - Adds
generateWebsiteto the programmatic API example. - Wraps the single-page HTML preview sidebar nav in
.doc-sidebar__scroll.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
packages/backend.ai-docs-toolkit/README.md |
Expands CLI usage, options, troubleshooting, and API examples. |
packages/backend.ai-docs-toolkit/src/html-builder-web.ts |
Updates sidebar markup to match the scroll container structure used by website builds. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #7461 (FR-2912)
Summary
Documentation update to the
backend.ai-docs-toolkitpackage README, plus a small fix for thepreview:htmlsidebar that broke after FR-2768.README updates
docs-toolkit build:webanddocs-toolkit serve:webto the usage block and the command table.pdf --chapters/--note,build:web --strict/--no-strict/--optimize-images/--optimize-images-avif, and default ports forpreview/preview:html/serve:web.generateWebsiteexample to the programmatic API section.preview:html(no PDF) and adddocs-toolkit helpto the table.docs-toolkit: not foundsubsection — explains why pnpm skips thedocs-toolkitbin symlink on fresh clones/worktrees (install runs beforedist/cli.jsis built), whypnpm install/--forcedoes not fix it ("Already up to date" skips bin-linking), and thepnpm --filter <docs-pkg> rebuildfix plus a verify command.preview:html sidebar fix
.doc-sidebar__scrollinhtml-builder-web.tsto mirrorwebsite-builder.ts. FR-2768 made.doc-sidebara fixed-heightoverflow:hiddenflex column and delegated scrolling to an inner.doc-sidebar__scrollelement (styles-web.ts).website-builder.ts(build:web/serve:web) emits that wrapper, but the legacy single-page preview builder (html-builder-web.ts, used bypreview:html/preview:html:ko) was never updated, so the nav overflowed a clipped container with no scrollport and the sidebar could not scroll.