tvkitchen / meta

A meta repository for discussions and tasks that span the project
Apache License 2.0
1 stars 0 forks source link

Generate documentation #8

Closed chriszs closed 2 years ago

chriszs commented 4 years ago

Per @reefdog:

We should probably be generating docs but I do think this is fine until we are!

Auto-generated docs tend to be unfriendly, but so long as we're using JSDoc, it might be good to start auto-generating the friendliest-looking doc pages we can in part so we can try to understand how the API will play to external audiences and catch issues now (like how issues with drafts are often caught in proofs). Could provide the basis/go along with more curated docs later.

slifty commented 4 years ago

hey hey hey but what about this way more impressive origin story:

"maybe I shouldn't actually try to document things here, and instead we should be generating documentation" - @slifty

shakes fist at @reefdog

actually though thank you for making the issue!

I like the thinking of "auto generate as first step, move to manual over time" -- and the manual can come after we finish our brand language / as part of the website design.

One note about timing: I wouldn't want the auto-documentation to take a major effort just yet since I do think having the caption generation milestone knocked out takes priority.

reefdog commented 4 years ago

I don't recall that origin story at all.

chriszs commented 4 years ago

Looks like a good way to do this before we have a final website would be to include a jsdoc-to-markdown script and have us generate API docs in the docs folder for anything with a JSDoc change.