react-wildcat icon indicating copy to clipboard operation
react-wildcat copied to clipboard

Documentation Umbrella Task

Open jamsea opened this issue 9 years ago • 3 comments

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:

  • [x] react-wildcat-ensure
  • [ ] react-wildcat-handoff
  • [ ] react-wildcat-hot-reloader
  • [x] 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.

jamsea avatar Oct 03 '16 20:10 jamsea

Hello @jamsea Is the issue still available to be resolved? I can look into resolving it if possible.

tjdev7 avatar Dec 31 '21 00:12 tjdev7

I don’t have merge permissions on this repo anymore. @miblanchard are y’all still maintaining this anymore or did you switch to NextJs?

jamsea avatar Dec 31 '21 13:12 jamsea

@Toughee @jamsea - This is now deprecated and no longer in use by our team.

I have not looked at this in a while, but I am adding a note to the README about deprecation.

miblanchard avatar Dec 31 '21 22:12 miblanchard