Skip to content

chore(docs): merge docs-v2-dev-draft into docs-v2#913

Open
DeveloperAlly wants to merge 1213 commits into
docs-v2from
merge/docs-v2-dev-draft-into-docs-v2-clean-20260525
Open

chore(docs): merge docs-v2-dev-draft into docs-v2#913
DeveloperAlly wants to merge 1213 commits into
docs-v2from
merge/docs-v2-dev-draft-into-docs-v2-clean-20260525

Conversation

@DeveloperAlly
Copy link
Copy Markdown
Collaborator

@DeveloperAlly DeveloperAlly commented May 26, 2026

Summary

Merges docs-v2-dev-draft into docs-v2 for the production handover, treating docs-v2-dev-draft as the source of truth.

This branch intentionally preserves draft-side deletions and cleanup decisions. The old v2/resources/redirect.mdx route/file was not reintroduced.

Latest update

  • Synced latest origin/docs-v2-dev-draft through commit 09678cb90 (cleanup).
  • Synced latest origin/docs-v2 through commit a72da56ca (chore(seo): refresh AI sitemap).
  • Resolved the base conflicts in favor of draft/current PR truth:
    • kept draft/current sitemap-ai.xml
    • kept the draft deletion of v2/resources/changelog/go-livepeer.mdx
  • Fixed 10 stale internal refs found by the strict v2 link audit after the latest draft sync.
  • Repaired CI root causes found after pushing:
    • Maintenance PR check now maps component-props validation to its supported changed-file scope and accepts --staged for component naming.
    • Component registry/catalog generated artifacts were refreshed from source.
    • Secret Scan now runs the open-source gitleaks CLI container instead of the licensed GitHub Action.

Merge policy

  • Source of truth: docs-v2-dev-draft
  • Base branch: docs-v2
  • Deleted files from the draft branch remain deleted in the merge result.
  • docs.json keeps v2 as the default docs version.
  • Thin-page review did not remove generated/dynamic pages that render substantial content through imports, OpenAPI, generated catalog trees, changelog entries, social/feed data, or landing-card grids.

Validation

Passed:

  • bash tools/lpd doctor --strict
  • npx -y mintlify@4.2.459 validate
  • node operations/tests/unit/docs-navigation.test.js --strict-missing
  • node operations/tests/integration/v2-link-audit.js --full --write-links --strict (latest run: 0 missing refs)
  • NODE_PATH=tools/node_modules node operations/scripts/dispatch/content/maintenance/dispatch-maintenance-check.js --staged
  • node operations/tests/unit/style-guide.test.js
  • node operations/tests/unit/spelling.test.js
  • git diff --check
  • test ! -e v2/resources/redirect.mdx
  • NODE_PATH=tools/node_modules MINT_BASE_URL=http://localhost:3334 node operations/scripts/validators/content/structure/test-v2-pages.js across all 608 v2 nav pages in scoped chunks

Notes:

  • Local Docker gitleaks could not be run because the Docker daemon is not active locally; the GitHub Secret Scan job now exercises the containerized CLI path.
  • npx mintlify broken-links was run, but it scans non-nav repo artifacts (workspace, templates, snippets, draft/review markdown) and reports parse/link errors outside the published v2 navigation. The repo strict v2 link audit passed with 0 missing refs.
  • Mint preview intermittently crashed during large sweeps; affected routes were rerun in scoped isolation and passed.

Known risks

  • This is a large handover merge with intentional file deletions inherited from docs-v2-dev-draft.
  • GitHub Actions should be reviewed closely because the draft branch substantially changes workflow/governance surfaces.

DeveloperAlly and others added 30 commits March 25, 2026 22:14
…S.md pointer

- ai-tools.mdx: add missing opening and closing --- frontmatter delimiters
- dev-tools.mdx: replace non-existent python3 generate-component-snippets.py
  with correct node generate-ui-templates.js --write path
- AGENTS.md: add content framework pointer (Frameworks.mdx + voice-rules.md)
  to Required Context section — makes locked taxonomy enums visible to all agents

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ork edits

Commits unstaged changes from prior sessions to prevent data loss:
- CLAUDE.md session log updates
- .github/AGENTS.md codex layer additions
- governance-index.mdx restructuring
- thread skill test log
- component/script framework edits
- workspace plan index and session log

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…doff

- snippets/templates/pages/resources/technical-reference/blockchain-contracts-template.mdx
- workspace/thread-outputs/research/staleness-remediation-handoff.md

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Phase 1A — generate-component-docs.js:
- Fix banner script path and all runCommand references from
  operations/scripts/generate-component-docs.js to correct
  operations/scripts/generators/components/documentation/generate-component-docs.js
  (4 banner instances + 8 runCommand instances)

Phase 1B — generated-artifacts.json:
- Fix 6 stale generator paths after scripts reorganisation into subdirectories
- Fix 3 sources entries with operations/operations/ double-directory typo
- All 11 node generator paths now resolve (verified with fs.existsSync)

Stale paths fixed:
- generate-docs-guide-components-index.js → generators/governance/catalogs/
- generate-docs-guide-pages-index.js → generators/governance/catalogs/
- generate-docs-guide-indexes.js → generators/governance/catalogs/
- generate-pages-index.js → generators/content/catalogs/
- generate-component-docs.js → generators/components/documentation/
- tests/unit/script-docs.test.js → operations/tests/unit/

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New page: v2/resources/documentation-guide/authoring-guide.mdx
Covers: frontmatter fields (all locked taxonomy enums), top 5 custom
components by import frequency, page templates with VS Code snippet
workflow, native Mintlify components, per-audience voice rules summary,
and verification/testing commands.

Not yet added to docs.json — requires separate approval.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
10 workflows have dead main-only triggers that never fire.
15 use bare git push without explicit branch target.
8 have phantom use_test_branch logic (input never defined).
6 missing workflow_dispatch for manual triggering.
6 checkout wrong branch on schedule/dispatch.

Report: workspace/thread-outputs/research/workflow-branch-audit.md

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ctive work streams

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- readme-path-verification.md: 55/66 paths resolve, 11 stale (all traced)
- readme-docs-guide-verification.md: all 24 canonical files exist, 3 broken external refs
- readme-repo-research.md: verified repo structure, counts, commands, contribution flow

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Complete rewrite from verified research (3 agent reports).
- 243 lines → 115 lines
- 11 stale file paths → 0 (all corrected to current locations)
- Internal ops manual → contributor-friendly entry point
- Added: branch structure (docs-v2/docs-v2-dev, not main)
- Added: verified repo counts (764 pages, 47 components, 160 scripts)
- Added: link to new authoring guide
- Trimmed "Where Details Live" from 24 rows to top 10 with index link
- All regeneration commands use correct post-reorganisation paths

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replaces 43-line stub (mostly TODOs) with 180-line product guide covering:
- AI assistants (Mintlify assistant, llms.txt, MCP server)
- Agent adapters (6 native adapters + Codex branch contract)
- AI skills (all 28 skills, categorised into 4 groups)
- AI-powered pipelines (glossary companions, content health, translation)
- Contributing AI tools (write skills, add rules, agent packs)

Distinct from ai-tools.mdx which remains the governance/registry index.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…sections

Updated from agent research (all paths verified on disk):
- Added status: current, lastVerified: 2026-03-27
- Restructured registry section into table with schema summary
- Expanded lane model with 4-column table and lifecycle states
- New: adapter inventory (9 adapters, all verified on disk)
- New: skills governance (templates, sync mechanism, lifecycle)
- New: rules governance (full ai-rules/ inventory)
- New: agent packs (6 subdirectories documented)
- New: cross-references to related governance pages
- Removed "Wave 1" framing; merged redundant sections
- Cross-links to ai-features.mdx for human-facing guide

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
DeveloperAlly and others added 12 commits May 19, 2026 15:36
Add a Features table covering:
  - Multi-tab IA
  - Resource HUB canonical aggregation layer
  - Composable wrapper pattern (with reference exemplar)
  - Hand-authored aggregations (FAQ, Guides, Troubleshooting)
  - Generated content pipelines
  - AI integrations and agent skills
  - Governance enforcement
  - Scoped dev server

Fix stale contributing links (authoring-guide and style-guide live under
copy-style/ subdir per the Documentation Guide IA).

Add explicit note that the Resource HUB Documentation Guide group wraps
every docs-guide/ contributor page, so browsing the contributor knowledge
base no longer requires switching to the Internal Hub.

Remove stray "# bft" line at file end.

[SKIP_STRUCTURE_CHECK bypass for pre-existing root-dir allowlist drift.]

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add FINAL-REPORT.md summarising the 7-commit Resource HUB consolidation:

  - 22 composable wrappers built (Phase 1a-1e)
  - 3 hand-organised aggregation pages (Phase 3)
  - 75 docs-guide wrappers (Phase 4)
  - Total 191 pages in HUB nav
  - 144/146 v2/resources/ HUB pages render correctly
  - 2 pre-existing failures unrelated to this thread:
      naap.mdx (false positive - content matches grep)
      style-guide.mdx (uses <Expandable> without importing)
  - 24 canonical composables exist, 0 routed in docs.json (constraint OK)
  - 5/5 audience-tab regression spot-check passed
  - All 7 public tabs verified per scoped restart

Report includes commit log for rollback, architecture summary
(composable wrapper / aggregation / docs-guide patterns), tooling
inventory, deferred items, known caveats, and a where-to-look index.

Resource HUB consolidation complete.

[SKIP_STRUCTURE_CHECK bypass for pre-existing root-dir allowlist drift.]

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Cron triggers leave inputs.dry_run empty (not the literal "false"), so the
previous FLAGS="" default-to-dry-run pattern silently broke every scheduled
write. Cron has been firing daily for 40+ days but writing nothing — root
cause of llms.txt + sitemap-ai.xml 40-day staleness, contracts data 21-day
staleness, and the "manual-only" classification of OG-images + SEO generators.

Scheduled jobs now default to --write --verify; manual dispatch can opt into
dry-run via inputs.dry_run=true. Manual-repair jobs unchanged (safe default
to dry-run preserved for human-triggered repairs). Post-merge jobs unaffected
(those already hardcode --write).

Affects 6 workflows: dispatch-{brand, copy, discoverability, governance,
health, maintenance}.yml. References docs-guide/features/automations.mdx
§ Known gaps and docs-guide/features/gap-analysis.mdx P0.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…-ups

Brings the entire docs-guide/ surface to canonical frontmatter compliance
(pageType, audience, purpose, status, lastVerified) — 85 .mdx pages, 0
blocking lint errors, 0 warnings across the folder.

Content corrections:
- Refresh cron-is-dry-run narrative across 5 references (ai-features.mdx,
  data-integrations.mdx) to point at the new "fixed 2026-05-25" anchor
  and reflect that the underlying P0 was shipped in commit e42946c.
- Refresh ownerless framing across 6 pages from stale "8 of 28 surfaces"
  to live "4 of 5 unified surfaces" post-D-ACT-10. Legacy
  ownerless-governance-surfaces.json marked superseded.
- Refresh github-actions framework v2.1 to v2.2 with 2026-05-22 4-tier
  refactor + D-ACT-09/10 + D-GOV-07/08; refresh Tier-table counts.
- Document the three new veracity dispatchers + the local-only
  social-feed dispatcher in automations.mdx + contributor-tools.mdx.
- Add "Resolved 2026-05-25" callout to top of gap-analysis.mdx
  summarising what closed in this consolidation pass.
- Refresh ai-tools.mdx skill/template counts (42 to 35 local + 53 portable;
  42 to 53 templates).
- Refresh index.mdx "What's stale today" against live state, split into
  Open vs Recently closed.
- Cross-check decisions registry: confirmed all 33 decisions present
  (D-ACT-01..10 + D-GOV-01..08 + D-DG-01..13 + D-NAV-01 + D-GLOS-01).

Generator fixes:
- generate-repo-governance-status.js + generate-root-governance-artifacts.js
  now emit canonical frontmatter (pageType / audience / purpose / status /
  lastVerified). Was emitting status: active (non-canonical) and missing
  the required pageType/audience/purpose entirely.
- tools/lib/governance/generated-file-banners.js helper extended to emit
  lastVerified (defaults to today). Backward-compatible.

Governance registry:
- Add jsconfig.json entry to root-governance.json (docs_runtime class,
  tool_discovery root_basis). Was driving folder-allowlist drift on every
  regen because the file exists at root but was not declared.
- .allowlist regenerated; jsconfig.json now permitted; one cosmetic
  blank-line normalisation.

Reference cleanup:
- 5 inbound links to retired docs-guide/standards/voice-rules.mdx stub
  rewired to docs-guide/standards/voice-and-copy.mdx
  (v2/GOVERNANCE.md, v2/{about,delegators}/_workspace/canonical/checks.mdx,
  v2/resources/documentation-guide/standards/voice-rules.mdx,
  v2/developers/_workspace/reviews/_packet/voice-copy-checklist.md).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
allowlist-edit: true
Use docs-v2-dev-draft as the source of truth for the production handover merge into docs-v2.

Validation: mintlify validate passed; v2 nav browser sweep passed across 608 routes; strict v2 link audit passed with 0 missing refs; docs navigation, spelling, style, doctor, and diff checks passed.
allow-deletions: true
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 26, 2026

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

Project Status Preview Updated (UTC)
na-36 🟢 Ready View Preview May 26, 2026, 1:16 AM

…draft-into-docs-v2-clean-20260525

allow-deletions: true

# Conflicts:
#	docs-index.json
#	v2/resources/changelog/go-livepeer.mdx
…cs-v2-dev-draft-into-docs-v2-clean-20260525

allow-deletions: true
allowlist-edit: true

# Conflicts:
#	docs-guide/repo-ops/config/repo-governance-map.mdx
#	operations/reports/health/page-links/page-links-audit.json
#	operations/reports/health/page-links/page-links-audit.md
#	v2/about/guides/network-metrics.mdx
#	v2/about/network/metrics.mdx
#	v2/about/protocol/mechanisms.mdx
#	v2/gateways/setup/publish/connect-with-offerings.mdx
#	v2/orchestrators/concepts/incentive-model.mdx
#	v2/resources/documentation-guide/copy-style/style-guide.mdx
…draft-into-docs-v2-clean-20260525

allow-deletions: true

# Conflicts:
#	sitemap-ai.xml
#	v2/resources/changelog/go-livepeer.mdx
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