Add dedicated docs - Githubissues

mozilla / nimbus-shared

Shared data and schemas for Project Nimbus

https://mozilla.github.io/nimbus-shared

Mozilla Public License 2.0

6 stars 15 forks source link

Add dedicated docs #57

Closed mythmon closed 4 years ago

mythmon commented 4 years ago

We can't write all our docs in README.md forever. This adds a the tools to generate a static site using React and Markdown. The idea is to then host it on Github Pages (though I'm open to other ideas there).

[x] Setup docs system
[x] Port README contents in
[ ] Finish TODOs in the docs
[x] Publish to GH Pages
[x] Link from README

Fixes #57

mythmon commented 4 years ago

Unfortunately, the artifact that is built by the CircleCI job aren't usable as-is because the site assumes it is hosted at the root of the web server. I think I can make it work for a specific prefix (for Github Pages), but I'm not sure if it is possible to have it work in the general case. I'll try that out.

mythmon commented 4 years ago

That worked! You can see the docs for this pull request at https://162-267090370-gh.circle-artifacts.com/0/artifacts/docs/index.html, and any other PR will include a similar artifact that can be accessed through CircleCI.

mythmon commented 4 years ago

Thanks for taking a look. The Chrome problems are definitely because I'm using CSS subgrid, which Chrome does not support. I don't think Chrome support here is a blocker :joy:. I'd be happy to take patches that improve the styling from any direction though. I was trying to timebox the time I spent on tooling here.

mythmon commented 4 years ago

Now we get to see if my automated deploy works :crossed_fingers: