Documentation Restructure
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 15/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
从链接的 RFP 和项目 16 开始,了解拟议的文档团队和已跟踪的工作。审查现有文档,并定义信息架构、利益相关者的 onboarding 路径、内容更新、AI 元数据、站点变更和维护工作流。完成的标准是:文档改造已在整个生态系统中交付,包括重定向、无障碍、版本管理和所有权指导。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- MDX
- 星标
- 46
- 派生
- 75
- 平均合并
- 1 小时 5 分钟
- 30 天内合并 PR
- 3
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
livepeer/docs 的其他 Issue
-
docs-v2
难度 1/5 1 小时以内 新手友好度 20/100
-
docs-v2 good first issue help wanted status: needs-triage
难度 5/5 一周以上 新手友好度 35/100
-
[docs-v2-index] Open + Recently Closed Issue Index可能重新可做 @DeveloperAlly 于 189 天前认领,目前没有进行中的 PR。 未关闭docs-v2
相似的 Issue
-
documentation v0.9.2
难度 2/5 半天 新手友好度 72/100
khuisman/mcp-gee-sweet#1033 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 2 天内回复
-
docs hacktoberfest help wanted
难度 2/5 1-3 小时 新手友好度 85/100
pacocartones/free-llm-api-hub#347 ·
维护者通常 1 天内回复
-
customer-reported question
难度 2/5 1-3 小时 新手友好度 62/100
Azure/azure-sdk-for-python#49548 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
The-Swarm-Corporation/swarms-framework-docs#302 ·
维护者通常 1 天内回复