Skip to content

feat(contracts): migrate docs-v2 contract surfaces#857

Merged
DeveloperAlly merged 1 commit intodocs-v2from
codex/20260403-contracts-docs-v2-migration
Apr 3, 2026
Merged

feat(contracts): migrate docs-v2 contract surfaces#857
DeveloperAlly merged 1 commit intodocs-v2from
codex/20260403-contracts-docs-v2-migration

Conversation

@DeveloperAlly
Copy link
Copy Markdown
Collaborator

Description

Migrates the working contracts surface from docs-v2-dev onto docs-v2 in an isolated worktree, including the contracts fetch/generation pipeline, generated datasets, canonical composables, route importers, and the repo-governed generated artifacts required for the branch to validate cleanly.

This keeps the migrated page behavior aligned to the existing docs-v2-dev source and does not introduce a standalone verifier route.

Scope

In scope:

  • .github/scripts/fetch-contract-addresses.js
  • .github/workflows/update-contract-addresses*.yml
  • operations/** contracts pipeline, tests, and script-library docs
  • snippets/composables/pages/canonical/**
  • v2/about/**, v2/resources/**, v2/gateways/**, v2/orchestrators/**
  • docs-guide/**, docs.json, docs-index.json
  • repo-generated artifacts required by hooks: .github/script-index.md, .vscode/**, tasks/reports/script-classifications.json, v2/templates/**

Out of scope:

  • no edits to the source Docs-v2-dev worktree
  • no behavior rewrite of the migrated contracts pages
  • no standalone verifier page or route

Validation

  • node operations/tests/unit/contracts-view-model.test.js
  • node operations/tests/unit/contracts-addresses-pipeline.test.js
  • node operations/scripts/validators/content/structure/lint-structure.js --check
  • node tests/unit/v2-link-audit.test.js
  • node tests/integration/v2-link-audit.js --staged --strict --report /tmp/livepeer-link-audit-precommit.md --report-json /tmp/livepeer-link-audit-precommit.json
  • bash ./lpd test --staged
  • isolated worktree preview verification of the migrated contracts pages, including Mermaid rendering on /v2/about/livepeer-protocol/blockchain-contracts

Notable outcome:

  • the staged WCAG hook passed with Blocking total (>= serious): 0, but its browser-backed lane reported a local infra fallback (Cannot find module 'axe-core/axe.min.js') and completed in static-only mode.

Follow-up Tasks

none

Type of Change

  • Bug fix (fixes an issue)
  • New content (adds new documentation)
  • Content update (improves existing content)
  • Style/formatting fix
  • Information architecture change
  • Other (contracts pipeline and generated-data migration)

Related Issues

Fixes #
Related to #

Changes Made

  • Migrated the contracts fetch/generation pipeline and its contract tests onto docs-v2.
  • Migrated the generated contracts datasets, canonical composables, and shared dependencies required by the contracts pages.
  • Wired the importer routes used from About, Resource Hub, Gateways, and Orchestrators into the docs-v2 surface.
  • Regenerated the docs-guide, docs index, script index, component registry/usage map, and template artifacts required by repo governance hooks.
  • Fixed the staged V2 link-audit root cause by keeping snippets/composables/** auditable while excluding non-composable snippets/** from the audited MDX import scope; docs-guide/** remains in scope.

Testing

  • Tested locally with scoped preview and repo validators
  • Verified all links work
  • Checked formatting and style
  • Reviewed against style guides
  • Screenshots (if UI changes)

Screenshots (if applicable)

Not applicable.

Checklist

  • My changes follow the style guides
  • I've reviewed the Component Library for available components
  • I've updated related pages if needed
  • I've checked for broken links
  • My changes are clear and easy to understand
  • I've tested locally
  • I've added/updated keywords and metadata if needed

Additional Notes

This branch was built from a separate docs-v2 worktree and kept the source docs-v2-dev worktree untouched.

Copy Governance Gate - L5

Complete before requesting review. Every item must be checked or the PR is not ready.

Auto-checked by CI (lint-copy.js + lint-structure.js)

  • No Tier 1 banned words or phrases
  • No unresolved {/* REVIEW: */} flags in rendered content
  • No non-USD currency outside declared regional scope
  • No empty cells in decision tables
  • pageType, audience, lastVerified present in frontmatter

Human review required

Sequence (L2)

  • Page opens with operator outcome - value kept, no conditionals
  • Majority operator path is featured before variants
  • Introduced paths are developed on-page or linked

Completeness (L3)

  • Decision aids (tables, matrices, flowcharts) are complete - no placeholders
  • Every warning or consequence is followed by a prevention action and link
  • Primary actions and URLs appear in body copy (not only in accordions)

Tone (L4)

  • No sentence ends on a hedge, disclaimer, or restatement
  • No section ends with a Note that apologises rather than forward-points

Brief compliance

  • L0 (Q1-Q4) was completed before drafting
  • L1 persona mapping table was completed before drafting

If any structural item fails: fix before requesting review. Do not ask a reviewer to identify the issue.

If the same section fails review twice: do not attempt a third fix. Escalate to the documentation lead for L6 diagnostic.

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 3, 2026

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

Project Status Preview Updated (UTC)
na-36 🟡 Building Apr 3, 2026, 11:39 AM

@DeveloperAlly DeveloperAlly merged commit 633c377 into docs-v2 Apr 3, 2026
3 of 10 checks passed
@DeveloperAlly DeveloperAlly deleted the codex/20260403-contracts-docs-v2-migration branch April 3, 2026 11:40
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

📊 V2 Browser Sweep Results

❌ Test report not found. The test may have failed before report generation.

  • Likely failed in setup/cache/server-start steps before npm run test:v2-pages.

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