RFC: New repository for code examples in Documentation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
该 issue 未指出任何文件、测试或入口点;请先查看现有文档及其中的代码片段。完成标准是创建一个单独的 repository,其中包含主要类的可运行示例,并在文档中添加指向这些示例的直接引用。
由索引模型根据 Issue 内容生成。
描述
Most of the documents bring code snippets. Considering that full file examples would take a lot of space in the documents and make them complex, a new repository with running examples per main classes would be a useful complement to them. The documentation could make direct reference to them. The users can clone the repository and run the examples in his/her local environment to have fully running demos of the code cited in the docs.
- 主要语言
- MDX
- 星标
- 22
- 派生
- 29
- 平均合并
- 28 分钟
- 30 天内合并 PR
- 3
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
phalcon/documentation 的其他 Issue
-
Document DataMapper\ORM可能重新可做 @niden 于 596 天前认领,目前没有进行中的 PR。 未关闭documentation enhancement
phalcon/documentation#247 · 已指派 1 人 ·
-
Document DataMapper\Mapper可能重新可做 @niden 于 596 天前认领,目前没有进行中的 PR。 未关闭documentation enhancement
phalcon/documentation#246 · 已指派 1 人 ·
-
Document DataMapper\Cli可能重新可做 @niden 于 596 天前认领,目前没有进行中的 PR。 未关闭documentation enhancement
phalcon/documentation#245 · 已指派 1 人 ·
-
Document DataMapper\Info可能重新可做 @niden 于 596 天前认领,目前没有进行中的 PR。 未关闭documentation enhancement
phalcon/documentation#244 · 已指派 1 人 ·
-
Document DataMapper\Table可能重新可做 @niden 于 596 天前认领,目前没有进行中的 PR。 未关闭documentation enhancement
phalcon/documentation#243 · 已指派 1 人 ·
查看 phalcon/documentation 的全部 Issue
相似的 Issue
-
Logo Redirect未关闭
难度 2/5 1-3 小时 新手友好度 85/100
-
难度 1/5 1 小时以内 新手友好度 67/100
materialdigital/core-ontology#528 ·
维护者通常 1 天内回复
-
triage-needed
难度 2/5 1-3 小时 新手友好度 76/100
MicrosoftDocs/edge-developer#3970 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 66/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
crazy-goat/rabbit-stream#753 ·
维护者通常 1 天内回复