Skip to content

Add "Further Information" resource links to all doc pages #2589

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

Open
markerikson opened this issue Aug 28, 2017 · 13 comments
Open

Add "Further Information" resource links to all doc pages #2589

markerikson opened this issue Aug 28, 2017 · 13 comments
Labels
Milestone

Comments

@markerikson
Copy link
Contributor

As seen in my React/Redux links list, there's tons of useful and relevant info about all things Redux online. The docs themselves can only cover so much actual info, and most of it is focused on the basics.

I try to end each of my blog posts with a "Further Information" section that includes links mentioned earlier in the page, and also has additional links to relevant articles and resources. I'd love it if we could add this type of info to each of our existing docs pages.

As a starting point: the "Structuring Reducers" docs section has a page called "Prerequisite Concepts" that links to some selected articles on topics like immutable data and normalization. However, the other pages in that section don't specifically reference those links. A few of those links could be added to the bottom of each page in the "Structuring Reducers" section, as appropriate.

For reference, a few of my posts:

@renatoselenica
Copy link

I would like to help out with this one.

@markerikson
Copy link
Contributor Author

@renatoselenica : great, thanks!

As I said in the issue, a good place to start would be adding appropriate links to the end of the "Structuring Reducers" docs section pages. I don't have a specific list of which links I want on which pages - I'll leave that up to you to come up with some initial suggestions. Please feel free to either add some comments here with your ideas so that we can discuss them, or go ahead and file some PRs and we'll go from there.

@renatoselenica
Copy link

Ok then. I will file a PR tomorrow and go from there. Would have done it today, but a few things came up.

@renatoselenica
Copy link

Hello. I just wanted to say that I cannot work on this issue for a while. I deeply apologize but some things came up unexpectedly. If someone else wants to take over, they are more then welcome to. Sorry for causing trouble

@markerikson
Copy link
Contributor Author

That's okay. Thanks for volunteering, and please let us know if you have time to help with this or other issues in the future!

@bonusrk
Copy link

bonusrk commented Nov 16, 2017

I can try to pick up this issue.
@markerikson As you said in first post, "Prerequisite Concepts" has a list of articles to read, and this list covers a bit almost all pages of "Structuring Reducers" section.

Maybe it is not a bad idea to copy some of them to related pages (for example Normalizing State Shape) with some additional links.
Like this article on Medium and 2 chapters from your glorious Practical Redux.

Normalizing Redux stores for maximum code reuse.
Practical Redux, Part 1: Redux-ORM Basics
Practical Redux, Part 2: Redux-ORM Concepts and Techniques

Is it what you meant?

@markerikson
Copy link
Contributor Author

@bonusrk : yeah, pretty much. In other words, the "Prerequisite Concepts" page links to "stuff it would be good to know before reading the rest of Structuring Reducers". But, if someone follows a link directly to the "Normalizing State Shape" page, they don't see any of those links. So, putting several related links at the bottom of the page would be helpful for people who want to learn more on the topic.

@bonusrk
Copy link

bonusrk commented Nov 19, 2017

@markerikson got it. Then i'll make a list like "pages : links-to-place-there" and place them here for your approval. Of course with usage of your React/Redux links list treasury :)

@markerikson
Copy link
Contributor Author

@bonusrk : sounds good - let me know when you've got a list put together!

@bonusrk
Copy link

bonusrk commented Nov 23, 2017

@markerikson thats how it looks for now. I still digging your "links mine".
The problem is that most part of articles there is so cool, that i just cant pass through them and read them fully =)
And of course it is just for Structuring Reducers part

Basic Reducer Structure
Idea : Give some basic information about Redux architecture, which starts from basic reducer structure
Links

10 Tips for Better Redux Architecture
Redux Best Practices
"Redux Best Practices?"

Splitting Reducer Logic
Idea: Give some best practice
Links
"Reducer composition without slicing state"
The Power of Higher-Order Reducers
Reducer composition with Higher Order Reducers

Refactoring Reducers Example
nothing yet

Using combineReducers
Idea: Some tips how and when use combineReducer
Links
4 Things for Efficient Redux
Taking Advantage of combineReducers

Beyond combineReducers
nothing here yet

Normalizing State Shape
Idea : Give more info about normalizing in general
Links
Redux Normalizr: Improve your State Management
Normalizing Redux stores for maximum code reuse.
Practical Redux, Part 1: Redux-ORM Basics
Practical Redux, Part 2: Redux-ORM Concepts and Techniques
Advanced Redux Entity Normalization
"Why are you supposed to normalize data in Redux?"

Updating Normalized Data
need investigation

Reusing Reducer Logic
Idea :Give some best practice about DRY inside redux
Links
Reducer composition with Higher Order Reducers
Higher Order Reducers - It just sounds scary

Immutable Update Patterns
Idea : Give additional info about immutability and it's usage inside reducers
Links
Modifying a Leaf of the Redux State Tree

Initializing State

@bonusrk
Copy link

bonusrk commented Dec 5, 2017

@markerikson Does it look reasonable to be added?

@markerikson
Copy link
Contributor Author

@bonusrk : a few initial thoughts:

Also, look at the "Prerequisite Concepts" page , and see which of those links would be appropriate to also have at the bottom of different pages (like some of the immutable data links).

@bonusrk
Copy link

bonusrk commented Dec 7, 2017

@markerikson got it. will dig that way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants