Generate documentation for an entire glint command tree

[TanklesXL]

Generate some kind of simple docs page (maybe markdown or HTML) that can act as a reference when using a glint CLI

[TanklesXL]

Hayleigh proposed the output be a JSON document

[jom-hedges]

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?

[TanklesXL]

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.

[jom-hedges]

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.

[tylerbutler]

Would you be open to something on v1? I’d be happy to put together a proposal for something in v1. I have an immediate need and was going to roll something on my own, but I can share it if there’s interest.

[TanklesXL]

@tylerbutler given that I haven't had as much time to work on v2 as I'd like, I think it would be okay to put together something for v1 if you want to take that on.

[tylerbutler]

I split the change into multiple pieces to make it easier to review. First piece is here: #99. It's impossible to do "stacked PRs" from forks in GitHub, so let me know if you want me to open up the rest of the PRs and arrange them so you can review individual commits. I want to make reviewing as easy as possible, so any suggestions you have there are welcome.