Redo documentation site entirely

eritbh commented 6 years ago

~~this is dumb just do it, everything is outdated and its ur fault~~

TODOs:

[ ] Go through and make sure all important facets of the lib are documented
- Make sure relevant doclets are supported
[ ] Make sure fetching info for different versions works
[ ] Eventually: clean up the code and make it less awful hopefully

eritbh commented 5 years ago

you mean typedoc

and by typedoc i mean typedoc --json docs/data.json and write a vue frontend for that output around the existing markup because i like the existing stuff

eritbh commented 5 years ago

This should be in a working state before I deploy 2.0. Updating milestone accordingly.

eritbh commented 3 years ago

This was never closed when it should've been I think, but also I need to not use Vue for this. If anything I want to write the current design into an actual Typedoc template rather than just reading the JSON, and I can add logic for switching between the different versions that way. The JSON signatures changing around means the site isn't keeping up with them and it's bad.

also how to handle maintenance for old JSON versions? The answer is you don't, you just generate HTML for each version rather than having to keep track of JSON output schema differences on the frontend. I should never have done it this way lol

eritbh commented 3 years ago

Done with #58 plus 1ddd7db0f4886e809827aaaf0a1412c2d5451560 through 98e16efc21438c676ab9edaf1b93044e72baf2da on the gh-pages side

eritbh / yuuko

Redo documentation site entirely #16