feat: doc generation command
Open
Nobody has claimed this yet.
- Dominant language
- Nushell
- Stars
- 335
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
Purely for tracking WIP. Related to:
- nushell/nupm#60
- nushell/nushell.github.io#1210
- amtoine/nu-git-manager#128
- https://discord.com/channels/601130461678272522/729071784321876040/1199113819386028102
Description
The only thing to add is it'd greatly help if the help command returned structured data (maybe help --detailed for symmetry with describe). Not creating that issue because the core team is in this repo and I'm not ready to implement it myself 😅
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Nushell's help command and the related issues nushell/nupm#60 and nushell/nushell.github.io#1210. Determine the scope of structured help output and how it would support documentation generation; done should include an agreed design and implementation path, but this issue names no files or tests.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100