Repository navigation
docs: split docs into per-project ArkType and Attest sections - #1686
Merged
Merged
Conversation
Uses fumadocs root folders so the sidebar shows a project switcher and only the active project's pages. Existing pages move into the `(arktype)` folder group, which fumadocs strips from slugs, so every existing /docs URL is unchanged. Further packages can be added as sibling root folders. Attest's README content moves to /docs/attest (setup, assertions, benches, options, cli, integration) with examples type-checked by twoslash. Its stale option defaults and broken custom assertion example are corrected, and the README now links to the docs instead of duplicating them. llms.txt is now generated from the ArkType section only, and is regenerated to include the cheat sheet. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes
Reviewed the per-project docs restructure (60 files): existing pages moved into content/docs/(arktype)/, plus the new Attest docs section.
- Route-group move — pages relocated under
(arktype)with"root": true. Verified against the installedfumadocs-core:getSlugsfilters names matching/^\(.+\)$/, so every existing/docs/...URL is preserved, andDocsLayoutderives the root toggle automatically from the tree. - New Attest docs — six pages under
content/docs/attest. Cross-checked the substantive examples against source: option defaults matchgetDefaultAttestConfig(ark/attest/config.ts), the.jsonsnapshot matchesdivisor.test.ts, the error messages matchstructure/index.tsanddivisor.ts, and the rewrittengetTypeAssertionsAtPositionexample matches theVersionedTypeAssertion/TypeRelationshipAssertionDatashapes. InstallationTabs— newpkg/devprops produce correct install commands for pnpm/npm/yarn/bun; the existing<InstallationTabs />call site still renders the same output.writeLlmsTxt— scoped to(arktype); regeneratedpublic/llms.txtadds only the cheat sheet, consistent with the stated intent.- Attest README trim +
@ark/attestdocs dependency —pnpm install --frozen-lockfilevalidates cleanly and prettier/eslint pass on the changed files.
No blocking or actionable issues found.
deepseek-v4.1-flash (free via Pullfrog for OSS) | 𝕏
Resolves the attest README conflict by keeping the trimmed README and moving main's TS version and getTypeAssertionAtPosition changes into the attest docs. writeLlmsTxt now writes one llms.txt per docs section, with attest's served at /docs/attest/llms.txt. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
ssalbdivad
added a commit
that referenced
this pull request
Oct 7, 2026
Main's #1686 moves attest's README content into the docs site, so the branch's bench guidance (median, returning results, threshold modes) is ported into attest/benches.mdx and llms.txt is regenerated. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
ssalbdivad
added a commit
that referenced
this pull request
Oct 8, 2026
ArkRegex's docs lived in its README and the announcement post. It now has its own root section at /docs/regex, mirroring the Attest split (#1686): setup, inference, errors, types (Regex, regex.infer/parse/validate, regex.as), ArkType integration and an FAQ. Types in the examples are twoslash queries, so they are computed from the built package and fail the docs build if they drift. The section gets its own llms.txt at /docs/regex/llms.txt. The primitives page links to it instead of the announcement, and the README now points at it instead of carrying the FAQ. The README's semver example switches from \d* to \d+, since \d* infers an eight-member union, not the type shown. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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.

Adds a project switcher to the docs sidebar using fumadocs root folders, starting with ArkType and Attest.
content/docs/(arktype)/folder group. Fumadocs strips groups from slugs, so every existing/docs/...URL is unchanged./docs/attest: setup, assertions, benches, options, CLI and integration. Examples are type-checked by twoslash. The README's stale option defaults and broken custom assertion example are fixed in the move.ark/attest/README.mdkeeps the intro and install and links to the docs instead of duplicating them.InstallationTabsacceptspkg/devprops.llms.txtis generated per section:/llms.txtcovers ArkType (now including the cheat sheet), and/docs/attest/llms.txtcovers Attest.More packages can be added as sibling root folders (
content/docs/<pkg>/meta.jsonwith"root": true).🤖 Generated with Claude Code