Skip to content

Merge/docs v2 dev draft into docs v2 20260522#908

Merged
DeveloperAlly merged 1199 commits into
docs-v2from
merge/docs-v2-dev-draft-into-docs-v2-20260522
May 22, 2026
Merged

Merge/docs v2 dev draft into docs v2 20260522#908
DeveloperAlly merged 1199 commits into
docs-v2from
merge/docs-v2-dev-draft-into-docs-v2-20260522

Conversation

@DeveloperAlly
Copy link
Copy Markdown
Collaborator

Description

Scope

Validation

Follow-up Tasks

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 (please describe)

Related Issues

Fixes #
Related to #

Changes Made

Testing

  • Tested locally with npm run dev
  • Verified all links work
  • Checked formatting and style
  • Reviewed against style guides
  • Screenshots (if UI changes)

Screenshots (if 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

DeveloperAlly and others added 30 commits March 23, 2026 16:59
…nkedin

Adds `iconColor` prop that overrides all icons to one colour when passed,
falling back to per-brand colours when absent. Also adds linkedin to both
the colour map and icon map.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…verview

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…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>
DeveloperAlly and others added 25 commits May 4, 2026 23:16
Convert 8 cross-audience go-livepeer reference pages to the composable
wrapper pattern proven by livepeer-contract-addresses:

  Canonical content -> snippets/composables/pages/canonical/go-livepeer/
  Audience wrappers -> v2/gateways/.../  v2/orchestrators/.../
  HUB wrappers      -> v2/resources/references/go-livepeer/

Pages converted: cli-reference, cli-commands, configuration-flags,
prometheus-metrics, hardware-requirements, bandwidth-requirements,
gpu-support, technical-architecture.

docs.json HUB nav (Reference > go-livepeer sub-group) now points at the
new HUB wrappers, so clicking from the HUB sidebar keeps the user in the
HUB context (no nav ejection to audience tabs).

Verified: 8/8 HUB wrappers + 8/8 gateway audience wrappers + orchestrator
gpu-support wrapper render canonical content with baseline marker grep
on actual rendered HTML.

Also includes: extract-and-wrap utility, verify-migration deep-check
script, migration-plan.json, phase1a-baselines, and the IA tree mdx.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Convert 4 developer-facing reference pages to composable wrappers:
  apis, sdks, pytrickle-reference, pricing-rate-limits

Canonical content -> snippets/composables/pages/canonical/apis-sdks/
Audience wrapper  -> v2/developers/resources/reference/{slug}.mdx
HUB wrapper       -> v2/resources/references/apis-sdks/{slug}.mdx

docs.json HUB nav (Reference > APIs & SDKs) updated to HUB wrappers.

Verified 4/4 HUB + 4/4 developer audience wrappers render canonical
content (marker grep on rendered HTML, scoped restart v2/resources +
v2/developers).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Convert 7 cross-audience network data references to composable wrappers:
  actors, arbitrum-rpc, arbitrum-exchanges, livepeer-exchanges,
  orchestrator-offerings, model-demand-reference, dashboards

Canonicals -> snippets/composables/pages/canonical/network-data/
HUB wrappers -> v2/resources/references/network-data/
Audience wrappers preserved at original paths (about/network, gateways/
compendium, orchestrators/reference, community/resources).

docs.json HUB nav (Reference > Network Data) updated to HUB wrappers.

7/7 HUB wrappers render canonical content (marker grep verified).

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

Convert 3 cross-audience reference pages to composable wrappers:
  livepeer-whitepaper, gateways-vs-orchestrators (Knowledge Hub)
  protocol-parameters (Reference > Contract Addresses & Protocol)

Canonicals:
  snippets/composables/pages/canonical/knowledge-hub/livepeer-whitepaper.mdx
  snippets/composables/pages/canonical/knowledge-hub/gateways-vs-orchestrators.mdx
  snippets/composables/pages/canonical/protocol-parameters.mdx

HUB wrappers:
  v2/resources/knowledge-hub/livepeer-whitepaper.mdx
  v2/resources/knowledge-hub/gateways-vs-orchestrators.mdx
  v2/resources/references/protocol-parameters.mdx

Audience wrappers preserved at original paths.

docs.json HUB nav updated. 3/3 HUB wrappers render canonical content.

Completes Phase 1: 22/22 composable wrapper migrations done (8 go-livepeer
+ 4 APIs/SDKs + 7 Network Data + 2 Knowledge Hub + 1 protocol-parameters).

[SKIP_STRUCTURE_CHECK bypass used to skip pre-existing root-dir violations
unrelated to this commit, per hook policy.]

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Three hand-organized canonical aggregation pages added to v2/resources/:

  v2/resources/faq.mdx (21KB)
    Aggregates 59 Q&A across 4 audience FAQs:
    - About Livepeer (6 Qs)
    - Community (12 Qs)
    - Gateways (15 Qs)
    - Orchestrators (26 Qs)
    Each Accordion preserved verbatim; sectioned by audience with source links.

  v2/resources/guides.mdx (36KB)
    Aggregates 3 audience guide indexes:
    - Community guides
    - Gateway guides
    - Orchestrator community-guides
    Each section preserves original body content with source page link.

  v2/resources/troubleshooting.mdx (48KB)
    Aggregates 2 audience troubleshooting pages:
    - Gateway troubleshooting
    - Orchestrator troubleshooting

All three pages aggregate component imports from sources (LinkArrow,
StyledTable, CustomDivider, BorderedBox, etc.) so the canonical renders
without ReferenceErrors.

Audience source pages remain unchanged in their tabs. The HUB pages are
new canonicals, not replacements.

docs.json HUB Compendium group updated: drops the 4-FAQ sub-group, adds
the 3 new HUB aggregation pages as top-level entries.

Render-verified: 3/3 HUB aggregation pages return HTTP 200 with correct
H1 and source-marker content present.

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

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Establish docs-guide/ as canonical SoT for governance documentation.
v2/resources/documentation-guide/ becomes the wrapper layer.

Created 75 thin wrappers under v2/resources/documentation-guide/ that
import and render their corresponding docs-guide/ canonical:

  Contributing (6):    contributing, contribute-to-the-docs, agent-instructions,
                       git-hooks, local-preview, mintlify
  Frameworks (13):     all docs-guide/frameworks/*.mdx except page-taxonomy-framework
                       (skipped — missing frontmatter)
  Standards (5):       authoring-standard, frontmatter, naming-conventions,
                       voice-and-copy, voice-rules
  Policies (17):       governance-index + 16 docs-guide/policies/*.mdx
  Features (12):       all docs-guide/features/*.mdx + existing
                       docs-features-and-ai-integrations
  Tooling (5+2):       lpd-cli, lpd-mdx-preview, dev-tools, ai-tools, snippets-inventory
                       + Reference Maps (badge-map, icon-map)
  Repo Operations (4): repo-config-map, repo-governance-map, root-governance-map,
                       enforcement-map
  Registry (6):        pages/components/scripts/templates/workflows-catalog,
                       ui-templates
  Docs Library (7):    index + 6 pipeline pages

docs.json HUB Documentation Guide group entirely rewritten — every entry
now points at a v2/resources/documentation-guide/ wrapper. docs-guide/
pages stay routed in the Internal Hub tab (deferred consolidation).

11/11 spot-check render-verified across all 12 sub-groups (correct H1,
no runtime errors, content present).

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

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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>
Standardised frontmatter scalars to double quotes and replaced em-dash
characters with en-dash in authored MDX. Generated by
.github/workflows/remediator-brand-repair-frontmatter-and-em-dashes.yml
@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)
na-36 🟢 Ready View Preview May 22, 2026, 7:16 AM

@DeveloperAlly DeveloperAlly requested a review from Copilot May 22, 2026 07:10
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@DeveloperAlly DeveloperAlly merged commit 63051da into docs-v2 May 22, 2026
1 check passed
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.

2 participants