Repository navigation
docs(website): give JSON its own API page - #820
Merged
Merged
Conversation
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>
|
| 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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
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.
Summary
api/json.md("JSON"), holding theJsonTypes,JsonPrimitive,JsonObjectandJsonArraysection fromtype-sets.md: the JSON-boundary rationale, the details onundefinedand optional properties, and the deprecatedJSON*names, which link to the v8 migration guide. The page has an intro, a reference table and a Source link tosrc/json.ts. It is the last page in the sidebar (order 19), after Type Sets, sosidebar.orderruns 1–19 with no gaps or duplicates and no other page is renumbered.required/requiredDeepmoved to the Object page, after "Combining records". Their rows are in its runtime-functions table and its Sources line now includessrc/unpartial.ts.type-sets.mdis now "Type Sets". Its intro, description, reference table and Source list cover onlyPrimitiveTypes,ComposableTypes/NonComposableTypesandUnionKeys, and it links to JSON.generate-llms-txt.mjs: each file directly undersrc/is now its own family, keyed by file name, in place of the singlerootfamily. This letsjson.ts,unpartial.tsand the type-set files point at different pages. Bothllms.txtfiles are regenerated.readme.mdJSON 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'stype-sets/#unionkeyslink 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