TanklesXL
Generate documentation for an entire glint command tree
Generate some kind of simple docs page (maybe markdown or HTML) that can act as a reference when using a glint CLI
hey there. I was looking around some projects in Gleam to find good first issues. Very interested in starting to contribute to the ecosystem. Is there still a need to generate a JSON reference doc?
Hey @jom-hedges i appreciate the interest in this issue! There is some preliminary design work involved before any actual development work gets done regarding how this feature should work and what the output should be.
If you'd like to spend some time thinking/designing a bit what the workflow and output should look like then I welcome the input! Feel free to drop any thoughts as messages in this issue to start.
Something to keep in mind: I'm working on adding type-safe required CLI arguments as part of glint v2, so things are likely to still be in flux there.
Wonderful, thank you for the guidance and considerations for glint v2. I'll spend some time using glint in some projects to familiarize myself with the codebase. Last year, I read a couple papers by Will Crichton and document languages, human-computer interactions, etc, so I'll grab those out of the cabinet to see what inspiration they bring.