You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thought about this while making docs updates on #81 -- I think it would be neat to explore what it would look like to auto-generate documentation from source code.
I tried several paths in the past but never found something that would work well. But it's been a while, maybe there is something new out there.
I think an ideal solution would be a tool that would pares the index.d.ts file and generate markdown API docs from that, and the output could replace a section in the README.md file. But I'd still want control over what we show and what we don't.
Alternatively we could generate the standard API docs as an addition, not a replacement for the existing documentation.
All this to say, feel free to explore if you are interested in the topic, and we see where we get with it.
Summary
Thought about this while making docs updates on #81 -- I think it would be neat to explore what it would look like to auto-generate documentation from source code.
Maybe https://typedoc.org/, https://jsdoc.app/, or similar?
The text was updated successfully, but these errors were encountered: