nushell / nushell/nushell.github.io
Generate documentation for `std` commands
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
The std module is only passingly mentioned in a placeholder page. Currently the only way to learn about it is introspection or reading https://github.com/nushell/nushell/blob/main/crates/nu-std/std/mod.nu (how I discovered it). The testing submodule is "deprecated" but that's a separate issue 👈🏼 Already moved to a crate. I don't have any reservation about alpha development stage since Nushell isn't 1.0 yet. Not opposed to a banner indicating it's less stable than other APIs.
Contributor guide
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 the placeholder page at nushell.sh/book/standard_library.html and compare it with crates/nu-std/std/mod.nu. Document the available std commands so newcomers can learn them without introspection or reading the source, and consider indicating that the APIs are in an alpha development stage.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100