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: improve file tree #77889

Conversation

devjiwonchoi
Copy link
Member

@devjiwonchoi devjiwonchoi commented Apr 7, 2025

The file tree can be improved and share the same convention:

  • Use the txt file extension.
  • One tab indented.
  • Use file tree with root . and trailing slash for folders.

x-ref: https://tree.nathanfriend.io

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. Documentation Related to Next.js' official documentation. labels Apr 7, 2025
Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@devjiwonchoi devjiwonchoi marked this pull request as ready for review April 7, 2025 09:52
@eps1lon
Copy link
Member

eps1lon commented Apr 7, 2025

Is this the only page we display a file tree in docs? Should strive for consistency here if possible.

@devjiwonchoi devjiwonchoi changed the title docs: improve file tree for static-dir-deprecated.mdx docs: improve file tree Apr 7, 2025
@devjiwonchoi devjiwonchoi requested a review from molebox April 7, 2025 11:13
@devjiwonchoi
Copy link
Member Author

Tried to cover existing file trees and apply same format.

@eps1lon
Copy link
Member

eps1lon commented Apr 8, 2025

Does that work with the current release of Geist font or do we need to wait for vercel/geist-font#158?

@devjiwonchoi
Copy link
Member Author

devjiwonchoi commented Apr 8, 2025

Does that work with the current release of Geist font or do we need to wait for vercel/geist-font#158?

The change is based on the existing code frame format of the extension txt. I don't expect it to be affected since it doesn't at the moment.

CleanShot 2025-04-08 at 13 55 41@2x

x-ref: https://nextjs.org/docs/app/building-your-application/configuring/mdx#using-file-based-routing
(For future readers, the content in this link may differ)

@devjiwonchoi devjiwonchoi merged commit b9620e6 into canary Apr 9, 2025
56 checks passed
@devjiwonchoi devjiwonchoi deleted the 04-07-docs_improve_file_tree_for_static-dir-deprecated.mdx_ branch April 9, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
created-by: Next.js team PRs by the Next.js team. Documentation Related to Next.js' official documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants