docs(zkapps): retire generated o1js API reference, delegate to docs.o1labs.org (Phase 1 of #1208)#1209
Open
dkijania wants to merge 1 commit into
Open
docs(zkapps): retire generated o1js API reference, delegate to docs.o1labs.org (Phase 1 of #1208)#1209dkijania wants to merge 1 commit into
dkijania wants to merge 1 commit into
Conversation
…1labs.org Phase 1 of the zkApp-section migration tracked in #1208. The o1js API reference under docs/zkapps/o1js-reference (217 auto-generated pages) is fully reproduced and actively maintained at https://docs.o1labs.org/o1js/api-reference, with a 1:1 URL structure (classes/*, functions/*, variables/*, type-aliases/*, namespaces/*). Delegate it there rather than keep generating a stale local mirror. - Remove docs/zkapps/o1js-reference/** (217 files) - Remove the "o1js Reference" category from sidebars.js - vercel.json: redirect /zkapps/o1js-reference(/**) and the legacy /zkapps/snarkyjs-reference/** to docs.o1labs.org/o1js/api-reference, with the index path landing on api-reference/Introduction - docusaurus.config.js: drop the snarkyjs-reference client redirect whose target no longer exists (vercel.json now handles that path) - Repoint the 12 in-repo pages that linked into the reference to the o1labs api-reference URLs (verified live, no 404s) - Regenerate static/llms-full.txt and static/llms.txt Verified with a full `docusaurus build` (onBrokenLinks: throw) — no broken links. Hand-written guides and the tutorial series are intentionally left in place; they are delegated later as o1labs reaches parity (see #1208). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
dkijania
added
docs
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Open
15 tasks
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
1 participant
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.
Phase 1 of #1208 — delegate the o1js API reference to o1Labs
Closes the first, lowest-risk step of the zkApp-section migration assessed in #1208.
What & why
docs/zkapps/o1js-reference/**is 217 auto-generated pages — a local mirror of the o1js API. The same reference is fully reproduced and actively maintained at https://docs.o1labs.org/o1js/api-reference (o1js 2.15.0), with an identical typedoc URL structure (classes/*,functions/*,variables/*,type-aliases/*,namespaces/*). Maintaining a second copy here only risks drift, so we delegate it.Changes
docs/zkapps/o1js-reference/**(217 files)sidebars.js(via the repo's own node + prettier pipeline)vercel.json: redirect/zkapps/o1js-referenceand/zkapps/o1js-reference/:path*(and the legacy/zkapps/snarkyjs-reference/:path*) todocs.o1labs.org/o1js/api-reference/*; the bare index lands on…/api-reference/Introductiondocusaurus.config.js: drop thesnarkyjs-reference → o1js-referenceclient redirect (target no longer exists;vercel.jsonnow covers that path)SmartContract,ZkProgram,Gadgets,Mina.getActions,Provable, etc. all return real pages, no 404s)static/llms-full.txt/static/llms.txtVerification
docusaurus buildpasses withonBrokenLinks: 'throw'— no broken internal linksstatic/llms-*.txtregenerated, socheck-llms-txtCI will passScope / out of scope
This PR is reference-only. The hand-written guides (
o1js/**,writing-a-zkapp/**), the tutorial series, CLI/Lightnet/Ethereum-dev guides, and Mina-network-specific content are intentionally left in place and delegated later as o1labs reaches parity — see the staged plan in #1208.🤖 Generated with Claude Code