This page is a proposed semantic icon map for current docs usage. It is meant to
make icon decisions easier to review before we enforce more of them.
Scope
- Scan scope:
- Exclusions:
- Generated:
docs-guide usage so the map is not
distorted by archived or translated duplicates.
Section Jump
Review Queue
These are the icons that look most overloaded or ambiguous in the current docs set.Inline Review Notes
wand-magic-sparkles
- Decision: keep
wand-magic-sparklesfor AI entry surfaces only. Good fits areBuild an AI productinv2/gateways/navigator.mdxandComfyStreaminv2/gateways/guides/node-pipelines/guide.mdx. - Products and named solutions should not inherit
wand-magic-sparklesby default: pages such asWhat is Daydream?inv2/solutions/daydream/overview.mdxandTranscodeinv2/solutions/livepeer-studio/reference/overview.mdxshould use a product icon or brand icon instead. - Quickstarts should use
bolt, notwand-magic-sparklesorrocket: this should become the default quickstart cue across portal and setup-entry surfaces. - Badges need their own icon map: the current
Developer Level Upbadge onRun a Gatewayinv2/gateways/portal.mdxandRun an Orchestratorinv2/orchestrators/portal.mdxshould move to a badge-specific set. Candidate icons:gamepad,trophy, ormedal. Follow-up: fold badge semantics into this icon map rather than creating a separate disconnected reference. - Managed or hosted platforms should use a consistent platform icon:
Managed Platforminv2/gateways/guides/deployment-details/setup-options.mdxshould converge oncloudas the default unless the platform has its own product icon. - Tutorials, guides, and references should use page-type icons instead: for example,
Building Real-Time AI Video Effects with ComfyStreaminv2/developers/guides/developer-guides.mdxshould resolve through tutorial or guide defaults rather than the AI-entry icon.
book
- Decision: keep
bookfor generic non-technical guides and concept pages. Good fits areContribution Guideinv2/developers/get-started/contributor-quickstart.mdxand concept-oriented reading surfaces where the destination is primarily explanatory. - References, tutorials, and resources should not default to
book:Orchestrator Referencesinv2/orchestrators/portal.mdxandOrchestrator Offerings Referenceinv2/gateways/guides/advanced-operations/production-hardening.mdxshould align to the resources/reference icon family instead. Tutorials should have their own default icon, likelycircle-play. - External docs should use a product icon first, then an external-doc fallback:
Daydream docsinv2/solutions/daydream/overview.mdx,ComfyStream documentationinv2/developers/get-started/comfystream-quickstart.mdx, andFrameworks docsinv2/solutions/frameworks/overview.mdxshould use a product icon where available, otherwise a generic external-link cue such asup-right-from-square. - Technical guides should use a technical-guide icon, not
book: items likePython SDK Quickstart (Official Docs)inv2/developers/guides/developer-guides.mdxshould likely move tolaptop-fileor the agreed technical-guide default. - GitHub destinations should always use
github:DocumentationandLivepeer Docsinv2/developers/guides/contribution-guide.mdxare GitHub links and should be branded as such, not rendered as generic books. - Likely default split by page type:
bookfor non-technical guides and concepts,laptop-filefor technical guides,circle-playfor tutorials, and the existing resources/reference icon family for references.
server
- Gateway or node deployment paths: used when the reader is choosing a self-hosted path. Examples:
Set Up a Gatewayinv2/developers/concepts/running-a-gateway.mdx,Solo orchestrator (go-livepeer)inv2/orchestrators/guides/setup-paths/find-your-path.mdx, andPath 4: Fleet / Enterpriseinv2/orchestrators/guides/setup-paths/setup-navigator.mdx. - Direct infrastructure configuration: used when the page is about explicit node-to-node or self-managed infrastructure setup. Examples:
Direct configuration (-orchAddr)inv2/gateways/guides/node-pipelines/ai-pipelines.mdxandSelf-hosted gateway (cost savings)inv2/gateways/concepts/business-model.mdx. - Infra software and node-adjacent services: also used for software or infrastructure resources rather than operator roles. Examples:
Livepeer Catalyst (MistServer)inv2/developers/guides/resources.mdx,Community Arbitrum Nodeinv2/community/resources/awesome-livepeer.mdx, andLivepeer LPMSinv2/gateways/resources/knowledge-base/resources.mdx. - Provider personas and opportunities: used for role-routing and grant surfaces as well. Examples:
Workload Providerinv2/developers/developer-journey.mdx,Earn from Idle GPUinv2/home/get-started.mdx, andSupply Side / Network Health Grantsinv2/developers/opportunities/grants-and-programmes.mdx.
tools
- Tooling or quickstart hubs: used when the destination is positioned as a tooling collection or jump-off page. Examples:
Quickstartinv2/gateways/portal.mdxandRunning AI Pipelines on your Orchestratorinv2/orchestrators/portal.mdx. - Setup helpers and install prerequisites: used when the card is really telling the reader to do setup work first. Examples:
Install Your Gateway Software Firstinv2/gateways/setup/requirements/on-chain setup/on-chain.mdx. - Verification and operational checks: used inside setup flows for confirmation steps. Examples:
Verify Configurationinv2/gateways/quickstart/views/docker/dockerOnChainTab.mdx. - Config utility views: also used for configuration-entry views that are not tool collections. Examples:
Full Config Guideinv2/gateways/setup/configure/video-configuration-view.mdxandGWID SPE toolinginv2/community/resources/guides.mdx.
coins
- Staking, rewards, and earnings: used when the topic is protocol economics or operator returns. Examples:
Earnings Explainedinv2/orchestrators/setup/activate.mdx,Staking & Rewardsinv2/orchestrators/setup/guide.mdx,LPT Inflationary Rewardsinv2/orchestrators/guides/staking-and-rewards/earnings.mdx, andProtocol Economicsinv2/about/livepeer-protocol/overview.mdx. - Delegator entry points: used for tokenholder and delegator routing. Examples:
Delegatorsinv2/about/livepeer-overview.mdx,Delegate LPTinv2/home/get-started.mdx, andLPT Token Purposeinv2/lpt/delegation/getting-started.mdx. - Gateway funding and payment steps: also used when the action is specifically about ETH funding or payment setup. Examples:
Funding Guideinv2/gateways/guides/payments-and-pricing/payment-guide.mdx,Depositinv2/gateways/guides/payments-and-pricing/funding-guide.mdx, andFund Your Gatewayinv2/gateways/guides/payments-and-pricing/remote-signers.mdx. - Treasury, grants, and revenue opportunities: used for ecosystem funding or opportunity surfaces. Examples:
Livepeer Treasury Explorerinv2/developers/opportunities/rfps-and-proposals.mdx,SPE Grant Modelinv2/gateways/guides/opportunities/community-ecosystem.mdx, andTreasury Foruminv2/community/livepeer-community/livepeer-latest-topics.mdx.
link
- On-chain mode labels: used when the icon stands in for the on-chain operational mode itself. Examples:
On-chain contextinv2/gateways/guides/payments-and-pricing/pricing-strategy.mdx,On-Chain Gatewayinv2/gateways/quickstart/views/docker/dockerOnChainTab.mdx, andOn-chain gatewayinv2/gateways/concepts/role.mdx. - Discovery, routing, and connection flows: used when the page is specifically about connecting to the network or discovering orchestrators. Examples:
On-chain discovery (-aiServiceRegistry)inv2/gateways/guides/node-pipelines/ai-pipelines.mdx,On-chain discovery (automatic)inv2/gateways/guides/node-pipelines/guide.mdx, andConnect to Arbitruminv2/orchestrators/setup/dep-config.mdx. - RPC and endpoint references: used for endpoint or connection resource links. Examples:
See All RPC Optionsinv2/gateways/setup/requirements/on-chain setup/on-chain.mdx,Community Arbitrum RPCinv2/developers/guides/resources.mdx, andConnect with Orchestrator Offeringsinv2/gateways/resources/knowledge-base/guides.mdx. - Generic external destinations: also used for links that are not really about connectivity. Examples:
Encode Clubinv2/developers/opportunities/grants-and-programmes.mdxandNext Video Build: Web3 Social with Lens Protocol and Next.jsinv2/developers/guides/developer-guides.mdx.
Data Location
The mapping lives in/snippets/data/reference-maps/icon-map.jsx.
That is deliberate:
- the page can render a reusable data source
- future validators can consume the same map without copying MDX tables
- more reference maps can sit beside it under
snippets/data/reference-maps/
snippets/data/reference-maps/
is the better home. tools/config/ should stay reserved for governed runtime or
script-facing config.