Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs Rewrite] Add Style Guide docs page #3626

Merged
merged 8 commits into from
Nov 20, 2019
Merged

Conversation

markerikson
Copy link
Contributor

@markerikson markerikson commented Nov 17, 2019


name: 📖 New/Updated Documentation Content
about: Adding a new docs page, or updating content in an existing docs page

PR Type

Does this PR add a new page, or update an existing page?

Adds a new page

Checklist

What docs page is being added or updated?

  • Section: Style Guide
  • Page: Overview

For Adding New Content

What kind of content category is this page (tutorial, how-to, explanation, reference)?

Good question. It's somewhere between an "explanation" and a "reference".

Who is the intended target audience?

All users who understand the basics and are looking for best practices.

What knowledge are we assuming they have?

General knowledge of how Redux works; terms like "action creator", "reducer", "side effects", etc.

What are the intended results or takeaways from reading this page?

Readers will know what the recommended approaches are for writing good Redux code.

What is the most critical info they should learn?

A bit hard to narrow it down given the length, but I'd say the first few "Essential" priority items.

@netlify
Copy link

netlify bot commented Nov 17, 2019

Deploy preview for redux-docs ready!

Built with commit f5276a8

https://deploy-preview-3626--redux-docs.netlify.com

@markerikson markerikson changed the title Docs/style guide [Docs Rewrite] Add Style Guide docs page Nov 17, 2019
@markerikson markerikson added this to the Docs Rewrite milestone Nov 17, 2019
@markerikson markerikson marked this pull request as ready for review November 20, 2019 05:37
@markerikson markerikson merged commit 9115b1e into master Nov 20, 2019
@markerikson markerikson deleted the docs/style-guide branch November 20, 2019 05:39
webMasterMrBin pushed a commit to webMasterMrBin/redux that referenced this pull request Aug 21, 2021
* Add initial Style Guide page

* Add CSS for style guide header highlighting

* Add initial style guide headings

* Format PR template

* Drop "copy/paste" phrasing

* Add additional style guide content

* Add several reducer entries

* Finish filling out main style guide content


Former-commit-id: dcc4a38
Former-commit-id: d7dbd4f
webMasterMrBin pushed a commit to webMasterMrBin/redux that referenced this pull request Aug 21, 2021
* Add initial Style Guide page

* Add CSS for style guide header highlighting

* Add initial style guide headings

* Format PR template

* Drop "copy/paste" phrasing

* Add additional style guide content

* Add several reducer entries

* Finish filling out main style guide content


Former-commit-id: dcc4a38
Former-commit-id: d7dbd4f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant