IBM / report-toolkit

A toolkit for consumers of Node.js diagnostic Reports
https://ibm.github.io/report-toolkit
Other
84 stars 10 forks source link

configure static site #31

Closed boneskull closed 5 years ago

boneskull commented 5 years ago

investigate https://gatsby-theme-carbon.now.sh/getting-started/

I want to use the Carbon Design System for the site, but I'm not sure of the easiest way from point A to B for our purposes. this might be it.

boneskull commented 5 years ago

TODO

  1. [x] finish content for landing page
    1. [ ] callouts for major features, link to docs
  2. [x] footer
  3. [ ] need app icon / graphic
  4. [x] format API documentation
    1. [x] handle breadcrumbs
    2. [x] handle deep nesting... somehow
  5. [x] update sidebar links
  6. [x] figure out deployment. netlify?
boneskull commented 5 years ago

I'm moving the in-depth docs (CLI, other tutorials) out past GA, because I'm probably not going to make that date.

the GA release can be a "preview" or "alpha" or something until I get the rest of the docs together (and hopefully get some more external feedback)

boneskull commented 5 years ago

"deep nesting" will just be handled by the breadcrumbs for now.

deployment will be github pages. needs impl though

boneskull commented 5 years ago

https://ibm.github.io/report-toolkit