unison icon indicating copy to clipboard operation
unison copied to clipboard

Doc website

Open hojberg opened this issue 3 years ago • 1 comments

We want to be able to render Unison Doc on the website to support the new documentation efforts.

This effort is dependent on being able to serialize docs to JSON and to render them with Elm:

  • https://github.com/unisonweb/unison/issues/2112
  • https://github.com/unisonweb/codebase-ui/issues/77

Additionally there are other efforts required:

  • [x] Setup a UCM for the website docs
  • [x] Finalize the way to structure the docs for rendering on the website
  • [x] Support element and social sharing image
  • [x] Finalize the web-design
  • [x] Figure out where the website UI code lives given that the Doc rendering lives in Codebase UI, but other aspect of the website doesn't really belong there.
  • [ ] Automate deployment of doc website
  • [ ] Add doc section on website and finetune doc output

hojberg avatar Jul 12 '21 19:07 hojberg

Phase 1 is a timeboxed design jam (2 meetings, Simon goes off and mocks a few things up between first and second meeting) to figure out what the front-end will need to do.

pchiusano avatar Jul 13 '21 17:07 pchiusano