Skip to content

Sync docs config schema with what the site reads #1084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tannerlinsley merged 1 commit into from
Jul 31, 2026
Merged

Sync docs config schema with what the site reads #1084

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions tanstack-docs-config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
"title": "TanStack Docs Config",
"description": "Config file for the documentation of a TanStack project.",
"type": "object",
"required": ["docSearch", "sections"],
"required": ["sections"],
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"docSearch": {
"description": "Data for Algolia Search.",
"deprecated": true,
"description": "Ignored. tanstack.com no longer reads this — the site's search client and index are configured in SearchModal.tsx, not per-library. Safe to delete from your config.",
"type": "object",
"required": ["appId", "apiKey", "indexName"],
"properties": {
"appId": {
"type": "string"
Expand All @@ -37,6 +37,10 @@
"label": {
"type": "string"
},
"tab": {
"$ref": "#/$defs/tab",
"description": "Default docs nav tab for every child in this section. Individual children can override it."
},
"children": {
"description": "Framework-agnostic docs go here.",
"type": "array",
Expand All @@ -52,7 +56,8 @@
"type": "string"
},
"badge": {
"type": "string"
"type": "string",
"description": "Free-form tag appended to this page's entry in the generated llms.txt (e.g. \"experimental\"). Not shown in the sidebar — the sidebar overwrites this with the page's framework provenance."
},
"addedAt": {
"type": "string",
Expand All @@ -63,6 +68,10 @@
"type": "string",
"format": "date",
"description": "Date the page was last meaningfully updated (e.g. \"2026-06-01\"). Shows an \"Updated\" pill in the sidebar for 7 days."
},
"tab": {
"$ref": "#/$defs/tab",
"description": "Docs nav tab this page belongs to. Overrides the section's `tab`. Omit to let the site infer one from the labels and path."
}
}
}
Expand All @@ -88,7 +97,8 @@
"type": "string"
},
"badge": {
"type": "string"
"type": "string",
"description": "Free-form tag appended to this page's entry in the generated llms.txt (e.g. \"experimental\"). Not shown in the sidebar — the sidebar overwrites this with the page's framework provenance."
},
"addedAt": {
"type": "string",
Expand All @@ -99,6 +109,10 @@
"type": "string",
"format": "date",
"description": "Date the page was last meaningfully updated (e.g. \"2026-06-01\"). Shows an \"Updated\" pill in the sidebar for 7 days."
},
"tab": {
"$ref": "#/$defs/tab",
"description": "Docs nav tab this page belongs to. Overrides the section's `tab`. Omit to let the site infer one from the labels and path."
}
}
}
Expand Down Expand Up @@ -127,5 +141,12 @@
"type": "string"
}
}
},
"$defs": {
"tab": {
"description": "One of the docs nav tabs rendered above the sidebar.",
"type": "string",
"enum": ["home", "get-started", "tutorial", "guides", "api", "examples"]
}
}
}
Loading