Improve docs

仓库指标

Star

2,465 star (2,465 star)

PR 合并指标

30 天内没有已合并 PR (30 天内没有已合并 PR)

描述

贡献者指南

研究方向

该问题旨在使用 Apple 的 DocC 改进文档。主要障碍是 DocC 输出无法托管在 GitHub Pages 上。一种可能的方法是研究替代托管方案，例如使用 GitHub Actions 部署到其他静态站点主机（如 Netlify 或 Vercel），或寻找 GitHub Pages 的变通方案。此外，检查仓库中的现有文档（例如 README、Docs 文件夹），以了解结构并确定需要添加的内容。

技术栈

swift

领域

documentation

议题类型

文档

难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。

2

预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。

1-3 小时

活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。

活跃

清晰度议题是否清楚说明期望改动、验收标准和下一步。

清晰

前置要求

Git

新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。

80