Documentation Restructure
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 15/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- markdown
- Ambito
- documentation
Direzione di ricerca
Inizia con l’RFP collegato e il progetto 16 per comprendere il team di documentazione proposto e il lavoro tracciato. Esegui un audit della documentazione esistente e definisci l’architettura delle informazioni, i percorsi di onboarding degli stakeholder, gli aggiornamenti dei contenuti, i metadati AI, le modifiche al sito e il workflow di manutenzione. Il lavoro è completato quando la revisione documentata è stata realizzata nell’intero ecosistema, inclusi i redirect, l’accessibilità, il versioning e le indicazioni sulla ownership.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Goal:
Restructure, refresh, and modernize Livepeer’s documentation to make it stakeholder-focused, AI-first, and future-proofed.
Requirements:
Use the RFP process to fund a small documentation team to deliver a full documentation overhaul that improves usability, accuracy, and consistency across the ecosystem.
Key focus areas:
- Conduct full documentation audit and create a new information architecture (IA).
- Deliver stakeholder-focused onboarding paths (Developers, Delegators, Orchestrators, Gateway Operators).
- Rewrite and consolidate all core docs with updated APIs, SDKs, and examples.
- Integrate semantic structure and metadata for AI-readiness (LLM parsing, embedded assistant, Mintlify integration).
- Deprecate outdated Studio content and unify changelogs and versioning.
- Implement new design, redirects, and accessibility-compliant documentation site.
- Establish long-term maintenance workflow, contribution guide, and ownership model.
Tracked By:
https://github.com/orgs/livepeer/projects/16
Additional Context (optional):
Add relevant background, dependencies, or related discussions.
- Lingua principale
- MDX
- Stelle
- 46
- Fork
- 75
- Merge medio
- 1h 5m
- PR unite (30g)
- 3
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di livepeer/docs
-
docs-v2
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 20/100
-
docs-v2 good first issue help wanted status: needs-triage
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
[docs-v2-index] Open + Recently Closed Issue IndexForse di nuovo libera @DeveloperAlly l’ha presa 187 giorni fa e non c’è nessuna pull request aperta. Apertadocs-v2
Tutte le issue di livepeer/docs
Issue simili
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
bridgetownrb/bridgetown#1130 ·
-
Add TOC to repoAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
netlify/netlify-mcp#75 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 91/100
twbs/bootstrap#43050 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
docs(prompt): filer socket fragment hardcodes an issue-intent cap of 8 that Chore runs overrideApertaagent-butler-finding chore
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
jordansmall/spindrift#5128 ·
I maintainer di solito rispondono entro 1 giorno