Skip to content

fix(about): resolve QA-rejected issues across 6 About section pages#864

Merged
DeveloperAlly merged 4 commits intodocs-v2from
copilot/fix-about-section-links-and-typos
Apr 7, 2026
Merged

fix(about): resolve QA-rejected issues across 6 About section pages#864
DeveloperAlly merged 4 commits intodocs-v2from
copilot/fix-about-section-links-and-typos

Conversation

Copy link
Copy Markdown

Copilot AI commented Apr 7, 2026

Six pages in the About section were rejected in QA review for exposing internal editorial notes, placeholder text, broken markers, and a markdown-leak heading. This PR resolves all identified issues.

Description

Removes all user-visible internal content from the About section pages flagged in QA review. No content rewrites — surgical removal of draft artefacts only.

Changes by file

  • v2/about/concepts/livepeer-overview.mdx — Fixed typo incenticisesincentivises; removed <expandable title="Old notes"> block containing INSERT LIVEPEER ACTOR DIAGRAM HERE placeholder note and old draft actor descriptions
  • v2/about/concepts/mental-model.mdx — Removed <Note> image would be good </Note> which was rendering as the first visible element on the page
  • v2/about/protocol/livepeer-token.mdx — Removed #TODO from four section headings (Rewards Distribution, Governance, Treasury, Technical Mechanics); removed <Danger> box exposing "Move majority of this to token section…"; removed #MOVE THESE and #REVIEW inline markers; removed the unwritten "Economic Flow Diagrams" stub section
  • v2/about/resources/compendium/livepeer-glossary.mdx + v2/about/resources/x-deprecated/livepeer-glossary.mdx — Removed <Note> A Searchable view would be ideal here </Note>; removed ## ==== heading that was leaking into the "On this page" sidebar; fixed three pre-existing etc. banned-phrase copy-lint blocking errors in both files
  • v2/about/portal.mdx — No change; Whitepaper card link already correctly targets /v2/about/resources/knowledge-hub/livepeer-whitepaper

Scope

In scope:

  • v2/about/concepts/livepeer-overview.mdx
  • v2/about/concepts/mental-model.mdx
  • v2/about/protocol/livepeer-token.mdx
  • v2/about/resources/compendium/livepeer-glossary.mdx
  • v2/about/resources/x-deprecated/livepeer-glossary.mdx

Out of scope: No routing changes, no frontmatter edits, no component changes.

Validation

node operations/scripts/validators/content/copy/lint-copy.js \
  v2/about/concepts/livepeer-overview.mdx \
  v2/about/concepts/mental-model.mdx \
  v2/about/protocol/livepeer-token.mdx \
  v2/about/resources/compendium/livepeer-glossary.mdx \
  v2/about/resources/x-deprecated/livepeer-glossary.mdx

# Result: lint-copy complete: 0 blocking, 2 pre-existing warnings (human sign-off) across 1 file

Parallel validation: Code Review ✅ · CodeQL ✅

Follow-up Tasks

  • The two remaining WEAKENED_VALUE copy warnings in livepeer-overview.mdx are pre-existing and flagged for human sign-off per lint policy — not introduced by this PR.

Type of Change

  • Bug fix (fixes an issue)
  • Content update (improves existing content)
  • Style/formatting fix

Related Issues

Related to #

Changes Made

  • Removed all #TODO, #REVIEW, #MOVE THESE markers rendering as visible body text in livepeer-token.mdx
  • Removed <Danger> box with internal editorial instruction from livepeer-token.mdx
  • Removed <Note> and <expandable> blocks containing internal design/placeholder notes from livepeer-overview.mdx and mental-model.mdx
  • Removed ## ==== markdown-leak heading and internal <Note> from both glossary files
  • Fixed typo incenticisesincentivises

Testing

  • Tested locally with npm run dev
  • Verified all links work
  • Checked formatting and style
  • Reviewed against style guides

Checklist

  • I've checked for broken links
  • My changes are clear and easy to understand
  • I've tested locally

Governance Approval

Not required for this PR.

Copy Governance Gate - L5

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

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • edgedl.me.gvt1.com
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.mjs (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI and others added 3 commits April 7, 2026 11:59
- livepeer-overview.mdx: fix typo 'incenticises' → 'incentivises'; remove <expandable 'Old notes'> section containing exposed internal placeholder text
- mental-model.mdx: remove exposed '<Note> image would be good </Note>' internal design note
- livepeer-token.mdx: remove #TODO, #MOVE THESE, #REVIEW markers and <Danger> internal editorial note box
- compendium/livepeer-glossary.mdx + x-deprecated/livepeer-glossary.mdx: remove exposed '<Note> A Searchable view would be ideal here</Note>' and '## ====' markdown-leak heading; fix banned-phrase 'etc.' lint errors in pre-existing copy"

Agent-Logs-Url: https://github.com/livepeer/docs/sessions/1a43c7a2-5295-463d-875c-0e4a2777c603

Co-authored-by: DeveloperAlly <12529822+DeveloperAlly@users.noreply.github.com>
Agent-Logs-Url: https://github.com/livepeer/docs/sessions/1a43c7a2-5295-463d-875c-0e4a2777c603

Co-authored-by: DeveloperAlly <12529822+DeveloperAlly@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix broken links and typos in About section fix(about): resolve QA-rejected issues across 6 About section pages Apr 7, 2026
Copilot AI requested a review from DeveloperAlly April 7, 2026 12:04
@DeveloperAlly DeveloperAlly marked this pull request as ready for review April 7, 2026 12:09
@DeveloperAlly DeveloperAlly merged commit 93456d4 into docs-v2 Apr 7, 2026
2 checks passed
@DeveloperAlly DeveloperAlly deleted the copilot/fix-about-section-links-and-typos branch April 7, 2026 12:10
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.

QA Review: About Section — docs.livepeer.org/v2/about

2 participants