Skip to content

docs: split the client API guide and sort the navigation - #594

Merged
devopvoid merged 1 commit into
mainfrom
docs/restructure
Nov 13, 2026
Merged

devopvoid merged 1 commit into
mainfrom
docs/restructure

Conversation

@devopvoid

Copy link
Copy Markdown
Owner

The client API guide (12,000 words on one page) becomes an overview and eight pages under guide/client/. Edge cases move to a Details section at the end of each page; the text itself is unchanged.

  • The core API steps leave Getting Started for a page of their own, guide/core-api.
  • Links to moved sections, such as the README's client-api#whip-and-whep, are sent on to their new page (theme/moved.ts).
  • Pages that show only the core API name the client API page for the same task (<ApiNote>).
  • Sidebar, guide overview and page titles agree; Client API Design and Build Notes move to a Background group.
  • The introduction compares the two APIs instead of quoting the license, and GitHub links point at main.

The client API guide becomes an overview and eight pages, the core API steps leave Getting Started for a page of their own, and links to moved sections are sent on. Core API pages name their client API counterpart, and the overview, titles and sidebar agree.
@devopvoid
devopvoid added this pull request to stack #596 November 13, 2026 00:54
@devopvoid
devopvoid merged commit 292031e into main Nov 13, 2026
10 checks passed
@devopvoid
devopvoid deleted the docs/restructure branch November 13, 2026 01:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant