Project: New Docs MVP
time-estimate: 20.4h
name: New Docs MVP
assignees: @djudjuu Description
The aim of this project is to build a minimal version of the new documentation (described in detail here, that is not comprehensive but describes some crucial elements that have not been clear or missing in the current one. It will use a format that can easily be extended and built-upon to incorporate more complicated and custom elements (such as simulations, folded-away notes, ...).
(this snippet includes notes on possible pages of an extended version of the docs, regular questions asked of fathom and a brief outline of what the 5 initial pieces (2 of which will be implemented here), shall be)
Motivation
In order to understand what ideas of the new docs are working and which not, we need to built out a prototype, which can grow incrementally to incorporate new elements (pages).
Timeline
- Choosing a tech-stack: 4h
- Writing two pieces in reduced format: 6h
- deploying pieces in new stack: 2h
- Spelling out pieces: 5h
Total: 17h +20% review & iterate: 20.4h
Deliverables
-
tech stack rationale -
one custom component (sidenote, foldup,...) -
deployed site with 2 pages -
migrated previous docs (if makes sense)