solidjs/solid-docs

[Content]: Better outline and information on FileRoutes

Open

#784 opened on Jun 18, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)MDX (363 forks)github user discovery
help wantedsolid-router

Repository metrics

Stars
 (289 stars)
PR merge metrics
 (PR metrics pending)

Description

📚 Subject area/topic

SolidStart, FileRoutes

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/solid-start/building-your-application/routing#file-based-routing

📋 Description of content that is out-of-date or incorrect

Users have expressed concerns regarding how file-based routing is documented. There isn't enough detail that's leading them to making mistakes:

Hey people can you help me with the nested routing while using FileRoutes
I have everything configured but nested route is showing page  not found

From our Discord where similar reports have been made a couple of times. What might be valuable is outlining nested routes in a clearer and more concise manner with more examples.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

Contributor guide

Research direction
Review the current file based routing documentation, identify unclear sections about nested routes, and add more detailed examples and explanations.
Tech stack
javascripttypescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic knowledge of SolidStart
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80