nushell / nushell/nushell.github.io
Improve the user flow for editing the (autogenerated) docs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
The Nushell website has links at the bottom of the page to "Edit this page on GitHub". Clicking the link takes the user through the process of updating that page using the GitHub web interface to create a pull request. That user flow bypasses the CONTRIBUTING.MD and it's not until after the PR is submitted the user is notified about not updating autogenerated docs.
Some suggestions to improve this for first time contributors.
- Remove the "Edit this page on GitHub" links on pages that should not be edited.
- Change or create the GitHub issue template specifying that certain pages, trees roots or paths should not be modified.
- Add a note about contributing to the README.md. As it is, the user is expected to know about the CONTRIBUTING.md document.
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
Read README.md and CONTRIBUTING.md first, then inspect how the website adds its “Edit this page on GitHub” links and how GitHub issue templates are configured. The work is done when pages that should not be edited no longer expose those links, the issue template identifies autogenerated paths, and README.md points contributors to the contribution guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100