crunchloop / crunchloop/devcontainer

docs: write public-facing reference docs in docs/

未关闭
#3 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
area/docs documentation
主要语言
Go
星标
5
派生
0
平均合并
6 小时 17 分钟
30 天内合并 PR
15

描述

PRD.md and design/*.md are gitignored during incubation. Before tagging v0.1.0, publish them as docs/ (rename + unignore + audit for any leftover internal references that survived the public-flip cleanup commit `5aaa8e9`).

Files: PRD.md, design/resolved-config.md, design/runtime.md, design/features.md, design/compose.md, design/status.md.

Status doc may be retired or replaced with a proper roadmap once we go public.

贡献指南

打开贡献指南

调研方向

阅读 PRD.md 和五个 design/*.md 文件,然后检查提交 5aaa8e9,以了解 public-flip 清理工作。将列出的材料发布到 docs/ 下,按需取消对源文件的忽略,审查是否有遗留的内部引用,并决定 status.md 是退役还是替换为 roadmap。

由索引模型根据 Issue 内容生成。

评估

领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
64/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。