Skip to content

docs: cross-link three o1js pages to their o1Labs counterparts - #1241

Open
dkijania wants to merge 1 commit into
mainfrom
docs/o1labs-crosslinks
Open

docs: cross-link three o1js pages to their o1Labs counterparts#1241
dkijania wants to merge 1 commit into
mainfrom
docs/o1labs-crosslinks

Conversation

@dkijania

@dkijania dkijania commented Sep 6, 2026

Copy link
Copy Markdown
Member

Part of #1228, #1229, #1234.

Of the 43 pages left under docs/zkapps/, 25 carry no link to docs.o1labs.org at all. This PR takes the three where an o1Labs counterpart clearly exists and is the more current reference.

Page Added Why
o1js/circuit-writing-primer.mdx conditional-logic, witnesses, analyzing-constraint-systems, what-is-a-zk-constraint-system o1Labs splits this material across three maintained pages; our single 1531-word primer linked to none of them (#1228)
o1js/basic-concepts.mdx the six basic-types/* pages + what-is-a-zk-constraint-system + conditional-logic o1Labs is more granular on the primitives than this page is (#1229)
o1js/bitwise-operations.mdx api-reference/variables/Gadgets The page describes these functions as gadgets but never linked their signatures (#1234)

The intent follows the division of labour in #1208: the zkApp-context framing stays on Mina docs, the reference detail is on o1Labs. Nothing is copied and nothing is deleted — these are links only.

Two of the linked pages (basic-types/arrays, basic-types/structs, basic-types/keypairs-and-signatures) were not in the original comparison at all; they turned up when I diffed the live o1Labs sitemap against docs/.

All eleven URLs verified live (HTTP 200) on 2026-09-06. static/llms-full.txt regenerated.

Not in this PR

The other 22 link-less pages. Some legitimately have no counterpart — install-zkapp-cli.mdx and how-to-deploy-a-zkapp.mdx are Mina-canonical by design — and the rest are covered by the stale-content issues (#1231, #1232) where a link is not the fix. #1234 tracks the sweep.

Context

From the docs2 ↔ o1Labs overlap comparison indexed in #1237.

🤖 Generated with Claude Code

https://claude.ai/code/session_012A5LmAdLpUcPELjgHg3C5e

Of the 43 pages left under docs/zkapps/, 25 carry no link to
docs.o1labs.org. These three are the ones where an o1Labs counterpart
clearly exists and is the more current reference.

- circuit-writing-primer.mdx: o1Labs splits this material across three
  maintained pages (conditional-logic, witnesses,
  analyzing-constraint-systems). Link all three plus the constraint-system
  primer, from the introduction and from "More Resources".
- basic-concepts.mdx: link the six o1Labs basic-types pages, which are
  more granular on the primitives than this page is, and the
  constraint-system primer. Also link conditional-logic from the
  Conditionals section.
- bitwise-operations.mdx: link the Gadgets API reference. The page
  described the functions as gadgets but never linked their signatures.

Keeps the zkApp-context framing on Mina docs and sends readers to o1Labs
for the reference detail, per the division of labour in #1208.

All eleven URLs verified live (HTTP 200) on 2026-09-06.

Refs #1228, #1229, #1234, #1208

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012A5LmAdLpUcPELjgHg3C5e
@vercel

vercel Bot commented Sep 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs2 Ready Ready Preview Sep 6, 2026 8:44pm UTC

Request Review

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