Docs: More Style Guide entries
See original GitHub issueWhat docs page is being added or updated?
- Section: Style Guide
- Page: Style Guide
For Updating Existing Content
What updates should be made to the page?
Some additional items I’d like to add:
- Organize reducers based on type of data and features, not specific components
- Use hooks as the default, instead of
connect
- Name state slices after their data, without the word
reducer
in the name (ie,state.users
, notstate.usersReducer
)
Any others we should add?
Issue Analytics
- State:
- Created 3 years ago
- Comments:8 (5 by maintainers)
Top Results From Across the Web
Style Guides - Write the Docs
A style guide saves documentarians time and trouble by providing a single reference for writing about common topics, features, and more.
Read more >What's new | Google developer documentation style guide
Expanded and clarified guidance about placeholders. Formatting placeholders. New entries: outside the box (and related terms), and more than 40 networking terms ...
Read more >StyleGuide.doc - Google Docs
(See more comma uses in series in AP Stylebook.) ... blog A website where short entries are usually (but not always) printed in....
Read more >Writing style guide - The MDN Web Docs project
This writing style guide describes how content should be written, organized, spelled, and formatted on MDN Web Docs.
Read more >How to Create a Style Guide: 5 Components of a Style Guide
Also known as a writing style guide, this manual establishes the standard requirements for grammar, punctuation, tense, tone, wording, and ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Recommendation like
'no-param-reassign': ['error', { props: true, ignorePropertyModificationsFor: ['state'] }]
, this will ignore rule forstate
variableGoing to mark this as resolved. I don’t think we specifically should add the
no-param-reassign
thing in the style guide, but I’ll mention it in the RTK “Writing Reducers with Immer” usage guide.