Create unlinked reference doc for new file system based route APIs #26222
Conversation
gatsbot
bot
added
the
status: triage needed
Gatsby Cloud Build Reportusing-styled-components 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 27s PerformanceLighthouse report
|
Gatsby Cloud Build Reportgatsby-master 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 1m PerformanceLighthouse report
|
Gatsby Cloud Build Reportclient-only-paths 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 25s PerformanceLighthouse report
|
Gatsby Cloud Build Reportusing-reach-skip-nav 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 25s PerformanceLighthouse report
|
Gatsby Cloud Build Reportgatsby 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 37m |
AishaBlake
added
type: documentation
There was a problem hiding this comment.
@blainekasten I've made some edits and renamed the guide to bring this doc more in line with the style guide (see the most recent commit) but I already see that I missed a couple of "we"s in there. In addition, I moved any file names associated with code blocks up into the code title div. I reworded a few things for increased clarity.
Thanks for your patience! Let me know your thoughts on this? I'll keep an eye out so that we can get this in ASAP.
| - `/src/pages/products/[...splat].js => /users/*splat` | ||
| - `/src/pages/app/[...].js => /app/*` | ||
|
|
||
| The dynamic segment of the file name (the part between the square brackets) will be filled in and provided to your components on a `props.params` object. For example: |
There was a problem hiding this comment.
Could you expand a little bit on the syntax here and lay out what ... and * are for in this context? I'm guessing not everyone who wants to use this will be familiar.
There was a problem hiding this comment.
I have updated it, wanna check it out?
Gatsby Cloud Build Reportgatsby 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 18m PerformanceLighthouse report
|
blainekasten
force-pushed
the
docs/fs-routing-reference-doc
branch
from
298ad23
to
26189d7
Compare
Co-authored-by: Aisha Blake <aisha@gatsbyjs.com>
Co-authored-by: Aisha Blake <aisha@gatsbyjs.com>
Co-authored-by: Muescha <184316+muescha@users.noreply.github.com>
Co-authored-by: Aisha Blake <aisha@gatsbyjs.com>
Co-authored-by: Aisha Blake <aisha@gatsbyjs.com>
blainekasten
dismissed
AishaBlake’s stale review
This all looks wonderful! You are so good Aisha!
| - `/src/pages/image/[...awsKey].js => /users/*awsKey` | ||
| - `/src/pages/image/[...].js => /app/*` |
There was a problem hiding this comment.
the right side doesn't match left side here - on the left /images/splat - on the right /users/splat or /app/splat
Description
We are going to be shipping #25204 soon behind a feature flag for a few weeks. When we promote it on social media, we want to link a reference document for users to see how to use the API. This is that doc, it's intentionally not linked to anything, and it's not necessarily meant to be a long term doc (though it could be a starting point for more things later).
Related Issues
#25204