Skip to content

docs(specs): migrate remaining proof spec pages from base/base#1500

Merged
leopoldjoy merged 3 commits into
masterfrom
leopoldjoy/migrate-remaining-specs
May 22, 2026
Merged

docs(specs): migrate remaining proof spec pages from base/base#1500
leopoldjoy merged 3 commits into
masterfrom
leopoldjoy/migrate-remaining-specs

Conversation

@leopoldjoy
Copy link
Copy Markdown
Contributor

@leopoldjoy leopoldjoy commented May 22, 2026

Summary

Migrates the six remaining proof spec pages still living in base/base under docs/specs/pages/protocol/proofs/ that are slated for deletion by base/base#2839, applying the same conventions used by the earlier specs migration in #1335.

This is a sibling PR to #1499 (which migrated tee-provers alone); together with #1335 it brings the full protocol/proofs/ tree from base/base into this repo.

Files migrated

Source (base/base @ docs/specs/pages/) Destination (base/docs @ docs/base-chain/specs/)
protocol/proofs/index.md protocol/proofs/index.mdx
protocol/proofs/challenger.md protocol/proofs/challenger.mdx
protocol/proofs/proposer.md protocol/proofs/proposer.mdx
protocol/proofs/registrar.md protocol/proofs/registrar.mdx
protocol/proofs/zk-prover.md protocol/proofs/zk-prover.mdx
protocol/proofs/contracts.md protocol/proofs/contracts.mdx

None of these pages reference any image, SVG, or bytecode asset, so no public/static/ content needs to come along.

Transformations applied (per-file)

Each migration applies exactly the same conventions used by #1335:

  1. .md -> .mdx.
  2. Prepend Mintlify title + description frontmatter.
  3. Strip the duplicate # Heading line (Mintlify renders the frontmatter title; matches existing pages like fault-proof/proposer.mdx, upgrades/azul/overview.mdx).

Body content is otherwise preserved verbatim from base/base, verified byte-equivalent after the listed transformations. (No internal .md-link stripping was needed for any of these six pages.)

Mermaid blocks (present in challenger.mdx, registrar.mdx, contracts.mdx) remain as standard ```mermaid fences -- Mintlify renders these natively (confirmed against existing usage in fault-proof/stage-one/bond-incentives.mdx and ai-agents/index.mdx; no <Mermaid> component needed).

docs.json navigation

Out of scope

Three other pages also being deleted by #2839 have not yet been migrated to this repo and are intentionally not included in this PR; they will be handled separately:

  • docs/specs/pages/protocol/execution/evm/rpc.md
  • docs/specs/pages/upgrades/pectra-blob-schedule/overview.md
  • docs/specs/pages/upgrades/pectra-blob-schedule/derivation.md

Caveats

Migrates the nine spec pages still living in base/base @
docs/specs/pages/ that are being deleted by base/base#2839,
applying the same conventions used by the earlier specs migration
in #1335:

- file extension .md -> .mdx
- prepend Mintlify title/description frontmatter (duplicate H1
  stripped, matching existing migrated pages)
- strip .md from internal cross-doc links (only affects two links
  in pectra-blob-schedule/derivation; external GitHub URLs left
  unchanged)
- wire each page into docs.json navigation:
  * Execution group: add evm/rpc
  * Proofs group: add index, challenger, proposer, registrar,
    zk-prover, contracts (alongside the existing tee-provers entry)
  * Upgrades > Optimism: add new Pectra Blob Schedule sub-group

Body content is otherwise preserved verbatim from base/base (verified
byte-equivalent after the listed transformations). Mermaid blocks
remain as standard ```mermaid fences (Mintlify-native; no <Mermaid>
component needed).
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
base 🟢 Ready View Preview May 22, 2026, 3:06 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cb-heimdall
Copy link
Copy Markdown
Collaborator

cb-heimdall commented May 22, 2026

✅ Heimdall Review Status

Requirement Status More Info
Reviews 1/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

Removes the three files from outside protocol/proofs/ that were
included in the previous commit:

- protocol/execution/evm/rpc.mdx
- upgrades/pectra-blob-schedule/overview.mdx
- upgrades/pectra-blob-schedule/derivation.mdx

These still exist in base/base and will need to be migrated
separately before base/base#2839 lands. Scoping this PR strictly
to the proofs subset of the deletion list.
@leopoldjoy leopoldjoy changed the title docs(specs): migrate remaining specs from base/base docs(specs): migrate remaining proof spec pages from base/base May 22, 2026
Matches the singular naming used by the other proof role pages
(challenger, proposer, registrar, zk-prover) and the parallel
rename in #1499.

- proofs/index.mdx: update the link label, slug, and verb agreement
  ('TEE Provers ... produce' -> 'TEE Prover ... produces')
- docs.json: update slug in the Proofs nav group

This is a small intentional deviation from the byte-equivalent
base/base source in proofs/index.mdx — flagged explicitly here.
@leopoldjoy leopoldjoy merged commit ab811cb into master May 22, 2026
8 checks passed
@leopoldjoy leopoldjoy deleted the leopoldjoy/migrate-remaining-specs branch May 22, 2026 13:31
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.

3 participants