Review all front-end-related documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- graphql, javascript, react, redux
- Domain
- documentation, frontend
Research direction
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.
Written by the indexing model from the issue text.
Description
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)
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from silverstripe/developer-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rules Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
silverstripe/developer-docs#909 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
silverstripe/developer-docs#908 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
silverstripe/developer-docs#907 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
silverstripe/developer-docs#903 ·
All issues in silverstripe/developer-docs
Similar issues
-
area:tools priority:p2 type:bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
amichai-bd/nand2mario#939 ·
-
Difficulty 2/5 Half a day Newbie friendliness 78/100
vercel/vercel-plugin#199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·