Guide for writing guides
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
先阅读 nix.dev/contributing/documentation/writing-a-tutorial 上现有的教程编写指南，然后阅读链接的文档团队讨论和 Diátaxis 指南。记录指南所采用的独特结构和写作风格，包括它们与教程的区别；新指南发布到文档网站后即视为完成。
由索引模型根据 Issue 内容生成。
描述
We have a guide for writing tutorials: https://nix.dev/contributing/documentation/writing-a-tutorial
But guides address a different need: looking up contextualised facts to execute common tasks or implement common workflows. That requires a particular structure and writing style, which is usually much more condensed and can leave out many details.
Related discussion on how to structure guides: https://discourse.nixos.org/t/2023-05-04-documentation-team-meeting-notes-45/27874#what-to-do-with-all-the-guides-2
- 主要语言
- Nix
- 星标
- 4k
- 派生
- 343
- 平均合并
- 1 天 12 小时
- 30 天内合并 PR
- 14
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
NixOS/nix.dev 的其他 Issue
-
site
难度 1/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 76/100
NixOS/nix.dev#1224 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
Add a small llms.txt index for official documentation可能已有人在做 @timfewi 今天认领。 未关闭site
难度 2/5 1-3 小时 新手友好度 35/100
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 55/100
维护者通常 1 天内回复
-
FAQ (idea draft)未关闭site
难度 3/5 1-2 天 新手友好度 35/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 74/100
juandresrodca/AdminForge#54 ·
-
hermes-queue
难度 1/5 1 小时以内 新手友好度 72/100
chrisalunlloyd2-sudo/mindpalace#349 ·
维护者通常 1 天内回复
-
external
难度 2/5 1-3 小时 新手友好度 68/100
langchain-ai/docs#7524 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复
-
bugfix low-priority plugin:abstract plugin:leyline small-effort source:discussion
难度 2/5 1-3 小时 新手友好度 66/100
athola/claude-night-market#1132 ·