New docs is great but difficult to find stuff on
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.1k
- Forks
- 1.1k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 9
Description
The new docs site is very spiffy, congrats on that. However it's difficult to use for a very common use case.
I used to come to the sops readme and ctrl+f and incrementally search through the readme to find what I was looking for. But now the docs site is split onto a bunch of different pages and there is no search feature. So I have to click around until I stumble on the right page.
Could the site get a search feature? Or a "All in one page" style option?
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 by reviewing the new docs site and its page structure, then assess whether site search or an all-in-one page best addresses the reported Ctrl+F workflow. Done means users can find the existing documentation without clicking through pages blindly, with the chosen behavior verified on the site.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100