Skip to content

docs(website): give JSON its own API page - #820

Merged
unional merged 1 commit into
mainfrom
docs-json-page
Oct 11, 2026
Merged

unional merged 1 commit into
mainfrom
docs-json-page

Conversation

@unional

@unional unional commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • New api/json.md ("JSON"), holding the JsonTypes, JsonPrimitive, JsonObject and JsonArray section from type-sets.md: the JSON-boundary rationale, the details on undefined and optional properties, and the deprecated JSON* names, which link to the v8 migration guide. The page has an intro, a reference table and a Source link to src/json.ts. It is the last page in the sidebar (order 19), after Type Sets, so sidebar.order runs 1–19 with no gaps or duplicates and no other page is renumbered.
  • required / requiredDeep moved to the Object page, after "Combining records". Their rows are in its runtime-functions table and its Sources line now includes src/unpartial.ts.
  • type-sets.md is now "Type Sets". Its intro, description, reference table and Source list cover only PrimitiveTypes, ComposableTypes/NonComposableTypes and UnionKeys, and it links to JSON.
  • generate-llms-txt.mjs: each file directly under src/ is now its own family, keyed by file name, in place of the single root family. This lets json.ts, unpartial.ts and the type-set files point at different pages. Both llms.txt files are regenerated.
  • The package readme.md JSON section links to the new page, as docs(website): give Bigint its own API page #819 did for Bigint.

No link on the site targeted the moved sections, and neither did the migration guide. object.md's type-sets/#unionkeys link still works.

No changeset: like #819, this changes only docs, the readme and llms.txt.

Verification

  • pnpm turbo run build --filter=website...: 0 errors. In the built HTML, api/type-sets/#unionkeys, guides/migrating-to-v8/#deprecated-in-80, and the JSON ↔ Type Sets links all lead to anchors that exist. The JSON page has no duplicate heading IDs.
  • pnpm verify: passes, 7/7 tasks.

🤖 Generated with Claude Code

Split "Type Sets and JSON": the JSON types move to api/json.md and
required/requiredDeep move to the Object page. type-sets.md is now
"Type Sets". The llms.txt generator maps each file under src/ root to
its own page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Oct 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: bb62ad6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets
Name Type
type-plus Patch

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov

codecov Bot commented Oct 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9b2b94c) to head (bb62ad6).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #820   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           40        40           
  Lines          173       173           
  Branches        30        30           
=========================================
  Hits           173       173           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@unional
unional added this pull request to the merge queue Oct 11, 2026
Merged via the queue into main with commit 63038ed Oct 11, 2026
7 checks passed
@unional
unional deleted the docs-json-page branch October 11, 2026 01:48
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