Unclear separation of "Private types"
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 20.8k
- Forks
- 2.3k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 156
Description
It took me a long time to see "Private types" in the righthand sidebar of https://svelte.dev/docs/kit/@sveltejs-kit. I got really confused that I couldn't find RequestEvent right above RequestOptions and thought it was missing from the side nav. If I didn't already know it was on the page I wouldn't have found it. That's how I eventually saw there's a separate "Private types" section
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 inspecting the documentation page at https://svelte.dev/docs/kit/@sveltejs-kit and its right-hand sidebar, focusing on how RequestEvent and RequestOptions are grouped. Determine a clearer separation or navigation treatment for private types, then verify that the affected type entries are discoverable from the rendered page.
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
- 45/100