Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(router): clarify dynamic route slug is about a file name, not "folder" #56596

Merged
merged 8 commits into from Oct 10, 2023

Conversation

cmbritten
Copy link
Contributor

@cmbritten cmbritten commented Oct 9, 2023

What?

Update documentation on dynamic routing to clarify the use of segment names within file names, rather than referring to them as "folder names".

Why?

The original documentation used the example term folderName when it was referencing dynamic segment names within filenames. The paths being described here are file names but not folders, and end in a file extension. This could confuse readers and developers, especially those new to Next.js, leading to potential misunderstandings and misconfigurations. Perhaps folderName was a relic of a different example wrapping a folder name to do a nested path or other configuration? But here it seems out of place.

How?

  • Reviewed the provided documentation sections on dynamic routing.
  • Replaced references to "folderName" with a different term "segmentName".
  • Ensured the examples provided in the documentation correctly showcase the use of segment names within filenames.

@cmbritten cmbritten requested review from a team as code owners October 9, 2023 01:39
@cmbritten cmbritten requested review from leerob and delbaoliveira and removed request for a team October 9, 2023 01:39
…ic-routes.mdx

Co-authored-by: Lee Robinson <me@leerob.io>
@cmbritten cmbritten requested a review from leerob October 9, 2023 03:39
leerob
leerob previously approved these changes Oct 9, 2023
@ijjk
Copy link
Member

ijjk commented Oct 9, 2023

Allow CI Workflow Run

  • approve CI run for commit: 6ebcc54

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

1 similar comment
@ijjk
Copy link
Member

ijjk commented Oct 9, 2023

Allow CI Workflow Run

  • approve CI run for commit: 6ebcc54

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@ijjk
Copy link
Member

ijjk commented Oct 9, 2023

Allow CI Workflow Run

  • approve CI run for commit: 276b437

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

update formatting for prettier
@kodiakhq kodiakhq bot merged commit c8064d6 into vercel:canary Oct 10, 2023
53 checks passed
@github-actions github-actions bot added the locked label Nov 2, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants