-
Notifications
You must be signed in to change notification settings - Fork 74
QA Review: About Section — docs.livepeer.org/v2/about #853
Copy link
Copy link
Open
Labels
docs-v2Livepeer docs v2 issue scopeLivepeer docs v2 issue scopehelp wantedstatus: needs-triageAwaiting maintainer triageAwaiting maintainer triage
Description
QA Review: About Section — docs.livepeer.org/v2/about
Reviewed all pages in the About section. Issues logged per page below.
❌ About Portal (/v2/about/portal)
STATUS: REJECTED
- [Broken Link] "Livepeer Whitepaper" card links to wrong page — Card labeled "Livepeer Whitepaper" uses
href="./livepeer-network/overview"and navigates to the Livepeer Network Overview page instead of the Whitepaper. Should point to/v2/about/resources/livepeer-whitepaper.
❌ Livepeer Overview (/v2/about/livepeer-overview)
STATUS: REJECTED
- [Typo] "incenticises" → should be "incentivises"
-
- [Broken Link] "Mental Model" inline link — uses
/about/mental-model(missing/v2/prefix) → 404
- [Broken Link] "Mental Model" inline link — uses
-
-
- [Broken Link] "Gateways" actor card — uses
/gateways/portal(missing/v2/) → 404
- [Broken Link] "Gateways" actor card — uses
-
-
-
-
- [Broken Link] "Delegators" actor card — uses
/lpt/token-portal(missing/v2/) → 404
- [Broken Link] "Delegators" actor card — uses
-
-
-
-
-
-
- [Broken Link] "Platforms/Workers" card — uses
/developers/portal(missing/v2/) → 404
- [Broken Link] "Platforms/Workers" card — uses
-
-
-
❌ Livepeer Core Concepts (/v2/about/core-concepts)
STATUS: REJECTED
- [Placeholder text — critical] Live page shows:
INSERT LIVEPEER ACTOR DIAGRAM HERE [THIS ONE LOOKS OLD (whitepaper)— internal editorial note visible to users -
- [Internal note exposed]
Actor diagram placeholder removed pending final approved asset.— internal note visible as a callout box on the live page
- [Internal note exposed]
❌ Livepeer Mental Model (/v2/about/mental-model)
STATUS: REJECTED
- [Placeholder text — critical] First visible element on page is a callout box reading:
image would be good— internal design note exposed to users
✅ Protocol Overview (/v2/about/livepeer-protocol/overview)
STATUS: APPROVED✓
✅ Core Mechanisms (/v2/about/livepeer-protocol/core-mechanisms)
STATUS: APPROVED✓
❌ Token (LPT) Utility (/v2/about/livepeer-protocol/livepeer-token)
STATUS: REJECTED
- [Incomplete content — critical]
#TODOappears in 4 sections: Rewards Distribution, Governance, Treasury, Technical Mechanics — sections not written yet but live on public page -
- [Internal note exposed]
#MOVE THESEvisible on page
- [Internal note exposed]
-
-
- [Internal note exposed]
#REVIEWvisible on page
- [Internal note exposed]
-
-
-
-
- [Internal comment exposed]
Move majority of this to token section. This section will just give a product/design decision overviewvisible in page body
- [Internal comment exposed]
-
-
✅ Governance Model (/v2/about/livepeer-protocol/governance-model)
STATUS: APPROVED ✓
✅ Treasury (/v2/about/livepeer-protocol/treasury)
STATUS: APPROVED ✓
✅ Protocol Economics (/v2/about/livepeer-protocol/economics)
STATUS: APPROVED ✓
✅ Technical Architecture (/v2/about/livepeer-protocol/technical-architecture)
STATUS: APPROVED ✓
✅ Network Overview (/v2/about/livepeer-network/overview)
STATUS: APPROVED ✓
✅ Actors Overview (/v2/about/livepeer-network/actors)
STATUS: APPROVED ✓
✅ Job Lifecycle (/v2/about/livepeer-network/job-lifecycle)
STATUS: APPROVED ✓
✅ Marketplace (/v2/about/livepeer-network/marketplace)
STATUS: APPROVED ✓
✅ Interfaces (/v2/about/livepeer-network/interfaces)
STATUS: APPROVED ✓
✅ Whitepaper (/v2/about/resources/livepeer-whitepaper)
STATUS: APPROVED ✓
✅ Livepeer Glossary (/v2/about/resources/livepeer-glossary)
STATUS: REJECTED
- [Markdown leak] "On this page" sidebar shows
====as a heading — raw Markdown horizontal rule leaking as a section title -
- [Internal note exposed] Callout box reads
A Searchable view would be ideal here— design/UX note exposed to users
- [Internal note exposed] Callout box reads
Summary
| Page | Status | Issues |
|---|---|---|
| About Portal | ❌ | Wrong link on Whitepaper card |
| Livepeer Overview | ❌ | 1 typo, 4 broken links (missing /v2/ prefix) |
| Core Concepts | ❌ | Placeholder text + internal editorial note exposed |
| Mental Model | ❌ | "image would be good" note exposed |
| Protocol Overview | ✅ | — |
| Core Mechanisms | ✅ | — |
| Token (LPT) Utility | ❌ | 4x #TODO, 3 internal notes exposed |
| Governance Model | ✅ | — |
| Treasury | ✅ | — |
| Protocol Economics | ✅ | — |
| Technical Architecture | ✅ | — |
| Network Overview | ✅ | — |
| Actors Overview | ✅ | — |
| Job Lifecycle | ✅ | — |
| Marketplace | ✅ | — |
| Interfaces | ✅ | — |
| Whitepaper | ✅ | — |
| Glossary | ❌ | Markdown leak + internal note exposed |
6 pages rejected, 12 approved.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docs-v2Livepeer docs v2 issue scopeLivepeer docs v2 issue scopehelp wantedstatus: needs-triageAwaiting maintainer triageAwaiting maintainer triage