Review all front-end-related documentation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- graphql, javascript, react, redux
调研方向
Start by reviewing the front-end documentation linked in the issue, especially the React injector material, the React API and major release policy references, and the GraphQL JavaScript documentation. Check issues 41 and 62 and pull request 215 for existing context. Done means the outdated or misleading guidance is corrected and the front-end documentation has a clearer structure with separate API and step-by-step guidance.
由索引模型根据 Issue 内容生成。
描述
Our front-end documentation is fractured, outdated, and in some cases potentially misleading. It could do with a review.
Some things to consider:
- https://docs.silverstripe.org/en/4/developer_guides/customising_the_admin_interface/reactjs_redux_and_graphql/#introduction-to-the-react-layer says the react API isn't part of our semver commitment, but that seems to be the only place that mentions it. It certainly isn't mentioned in our major release policy, which is the place where most people will look for that sort of information.
- It would be nice if there was a clearer structure to the doc - currently it seems to find information about javascript development in the CMS we have to traverse all over the place. These should be collected in a single section, ideally (see https://github.com/silverstripe/developer-docs/issues/41)
- In particular, the react injector documentation is very difficult to parse. It needs to be split into multiple pages. At the very least, there should be one page that focuses on the API of the react injector, and another that provides concrete step-by-step examples of how to use it in a specific narrow-scope project. At the moment those are mixed together, which ultimately means the step-by-step guide is hard to follow at best, and the documentation about the API isn't clear nor complete. See https://github.com/silverstripe/developer-docs/pull/215#issuecomment-1507784574
- A lot of our graphql js stuff is outdated (see https://github.com/silverstripe/developer-docs/issues/62)
- 主要语言
- 没有语言数据
- 星标
- 7
- 派生
- 76
- 平均合并
- 1 天 12 小时
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
silverstripe/developer-docs 的其他 Issue
-
6.0.0 changelog: DBField formatters on array getters now render empty可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
silverstripe/developer-docs#912 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rules未关闭affects/v6 complexity/low impact/low type/docs
难度 1/5 1 小时以内 新手友好度 92/100
silverstripe/developer-docs#909 · 1 条评论 ·
-
affects/v6 complexity/low impact/low type/docs
难度 2/5 1-3 小时 新手友好度 88/100
silverstripe/developer-docs#908 · 1 条评论 ·
-
affects/v5 affects/v6 complexity/low impact/low type/docs
难度 1/5 1 小时以内 新手友好度 90/100
silverstripe/developer-docs#907 · 1 条评论 ·
查看 silverstripe/developer-docs 的全部 Issue
相似的 Issue
-
sync-en
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
sync-en
难度 2/5 1-3 小时 新手友好度 83/100
维护者通常 3 天内回复
-
type: documentation
难度 2/5 1-3 小时 新手友好度 70/100
spring-projects/spring-boot#52092 ·
维护者通常 1 天内回复
-
[Bug] 官网文档的图片挂了未关闭bug
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 90/100
DietrichGebert/ponytail#1063 ·
维护者通常 3 天内回复