Skip to content

[Documentation] Add comments explaining currentList.js and redux files #626

Open
@jsnwesson

Description

@jsnwesson

The currentList.js file is what maintains the state for the visible list of courses that is eventually used by the CourseList component to render a list of CourseCards. It would behoove us to understand this file a little better. Currently, it doesn’t have any comments explaining what it does so consider adding some to explain the core functions.

There are also a handful of redux files that add layers of abstraction that may be confusing to new developers on the project.

Things to document for redux:

Selectors and learning how to differentiate them, for example, what is the difference between appSelectors, simpleSelectors, and courseCard selectors.

What this app.js file is doing may also be helpful

Explain the requests slice and how there are multiple slices for the store

In terms of where these comments should exist, it'd probably be the most helpful to either include them in the files themselves and/or the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelates to documentation improvementshelp wantedReady to be picked up by anyone in the community

    Type

    Projects

    Status

    Help Wanted

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions