Skip to content

Documentation Umbrella Task #162

@jamsea

Description

@jamsea

This was started in PR #140. I think it makes sense to split this up so we don't feel overwhelmed.

A good first step is to get a README.md file in each of wildcat's smaller packages. We've already finished a few of them:

  • react-wildcat-ensure
  • react-wildcat-handoff
  • react-wildcat-hot-reloader
  • react-wildcat-prefetch
  • react-wildcat-test-runners

https://github.com/nfl/react-wildcat/tree/master/packages/react-wildcat-prefetch is a great example of what we need for each of these projects. Just a markdown file explaining what the project is and an example of how to use it.

PR #140 introduces gitbook support which makes for some nicely formatted docs.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions