Skip to content

Teach IPv6 notation and separate language API guides - #33

Merged
jrepp merged 1 commit into
mainfrom
docs/ipv6-introduction-and-api-guides
Sep 9, 2026
Merged

Teach IPv6 notation and separate language API guides#33
jrepp merged 1 commit into
mainfrom
docs/ipv6-introduction-and-api-guides

Conversation

@jrepp

@jrepp jrepp commented Sep 9, 2026

Copy link
Copy Markdown
Owner

The documentation previously mixed an address-format reference with installation and API details. Rewrite the entry page as an IPv6 introduction that explains hexadecimal groups, zero compression, prefixes, common addresses, ports, zone IDs, and embedded IPv4 through worked examples and expandable practice questions.

Move API usage into separate C, JavaScript, and TypeScript guides, with a development page for builds, testing, and publishing. Share the documentation stylesheet and navigation, and update the README, demo, and existing guides to link to the new pages.

Validation:

  • Compiled and ran the C examples against the native library.
  • Ran the JavaScript and TypeScript examples; TypeScript uses strict application checking with the documented skipLibCheck workaround for existing package declaration conflicts.
  • Checked 106 local links, Pages links, assets, and anchors, plus the introductory address expansions.
  • Checked all five documentation pages at mobile and desktop widths in light and dark themes.
  • Verified navigation, expandable answers, demo links, and the standalone browser WebAssembly example without browser exceptions.
  • git diff --check passed.

The TypeScript guide documents existing declaration/runtime differences. This change does not modify the parser or its declarations.

@jrepp
jrepp merged commit ac1e1b8 into main Sep 9, 2026
38 checks passed
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