Skip to content

docs: split api docs by package#102

Merged
maxatwork merged 1 commit intomasterfrom
codex/api-package-docs
Mar 21, 2026
Merged

docs: split api docs by package#102
maxatwork merged 1 commit intomasterfrom
codex/api-package-docs

Conversation

@maxatwork
Copy link
Owner

@maxatwork maxatwork commented Mar 21, 2026

Summary

  • split the API reference into an /api/ package index plus /api/<package>/ pages sourced from separate docs markdown files
  • add left-side package navigation, package-specific routes, and a right-side TOC driven by a shared docs package registry
  • expand package docs with concrete option examples for schema usage and other important package-specific options

Test Plan

  • npm test
  • npm -w @form2js/docs run typecheck
  • npm run docs:build

Summary by cubic

Split the API reference into a package index at /api/ and per-package pages at /api/<package>/, with a left-side package nav and clearer TOC. Expanded each package’s docs with concrete examples and options.

  • New Features

    • New docs structure: docs/api-index.md plus docs/api-*.md for @form2js/core, @form2js/dom, @form2js/form-data, @form2js/react, @form2js/js2form, @form2js/jquery.
    • Added package navigation and an index summary grid; TOC now shown per page only when headings exist.
    • Markdown links now rewrite to the new routes (README.md, api-index.md, and per-package markdown -> /api/ paths).
    • Introduced registry-driven pages and routes: api-packages registry, apiPackageDocsPath, and new components ApiPackageNav and ApiPackageSummaryList.
    • Updated styles for nav, TOC, and summaries; tests added/updated for routes, nav, and anchors.
  • Migration

    • Edit per-package content in docs/api-*.md; the index lives in docs/api-index.md.
    • Update any links pointing to docs/api.md to target docs/api-index.md or the relevant package page.

Written for commit c6a7f6f. Summary will update on new commits.

@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 22 files

@maxatwork maxatwork merged commit 0f9928d into master Mar 21, 2026
8 checks passed
@maxatwork maxatwork deleted the codex/api-package-docs branch March 21, 2026 22:18
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