nushell / nushell/nushell.github.io
Please enhance the documentation for people using a CLI web browser, without JavaScript.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
Related problem
Hello, I maintain the Slint distribution https://slint.fr which is accessible to the blind.
Many blind users prefer to use the command line than a graphical environment and a use a CLI web browser like links, lynx or w3m that has no support for JavaScript. I have packaged nushell recently and folks using one of these browser find tedious to read the documentation, like books, commands or cookbook (you may want to try yourself) as they have to scroll down a lot before getting to the content.
Describe the solution you'd like
Have a version with just the content and a few links on top of it (like to go one or two levels up in the tree).
Describe alternatives you've considered
Provide a link on top of each page "skip to content".
Additional context and details
No response
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
Review the Nushell website's documentation pages in a CLI browser such as links, lynx, or w3m, and identify how their navigation and content are presented without JavaScript. Done means the books, commands, and cookbook pages expose content near the top with a small set of useful navigation links or a skip-to-content link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100