Skip to content

docs: add 'Set up your editor' to the installation guide#95928

Merged
aurorascharff merged 1 commit into
canaryfrom
aurorascharff/setup-your-editor
Jul 20, 2026
Merged

docs: add 'Set up your editor' to the installation guide#95928
aurorascharff merged 1 commit into
canaryfrom
aurorascharff/setup-your-editor

Conversation

@aurorascharff

@aurorascharff aurorascharff commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Summary

CleanShot 2026-07-19 at 01 07 57@2x

Adds a "Set up your editor" section to the App Router installation guide. The App Router names files by convention (page.tsx, layout.tsx, route.ts), so an editor quickly fills with same-named tabs. This section shows how to tell them apart with VS Code / Cursor custom editor labels, labeled two folders deep so dynamic routes like blog/[id]/page.tsx do not all collapse to the same [id] label. It includes:

  • A copy-paste .vscode/settings.json config (workbench.editor.customLabels.patterns) for setting it up by hand.
  • A copyable prompt that points a coding agent back at this section to apply the config, including adapting it to other editors.
  • A good-to-know that JetBrains IDEs (WebStorm, IntelliJ) do this automatically.

Verification

  • Previewed locally against the docs site: the section renders (HTTP 200), with the config block, the prompt card, and the good-to-know all rendering correctly.

@github-actions

github-actions Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Stats skipped

Commit: ede8cf8
View workflow run

@github-actions

github-actions Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Tests Passed

Commit: ede8cf8

@aurorascharff
aurorascharff force-pushed the aurorascharff/setup-your-editor branch from f7bb056 to 8476b2f Compare July 18, 2026 21:51
@aurorascharff
aurorascharff marked this pull request as ready for review July 18, 2026 22:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an App Router–only “Set up your editor” section to the installation guide to help developers distinguish same-named App Router files (e.g. page.tsx, layout.tsx) via editor tab labeling.

Changes:

  • Introduces a new “Set up your editor” section under <AppOnly> in the App Router installation guide.
  • Provides a copy/paste VS Code (and Cursor) workbench.editor.customLabels.patterns configuration for two-level-deep folder labeling.
  • Adds a copyable “prompt” block for delegating the setup to a coding agent, plus a JetBrains “Good to know” note.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/01-app/01-getting-started/01-installation.mdx Outdated
Comment thread docs/01-app/01-getting-started/01-installation.mdx Outdated
@aurorascharff
aurorascharff force-pushed the aurorascharff/setup-your-editor branch from 8476b2f to 5368fbc Compare July 18, 2026 23:01
@aurorascharff
aurorascharff force-pushed the aurorascharff/setup-your-editor branch from 5368fbc to ede8cf8 Compare July 18, 2026 23:12

@icyJoseph icyJoseph left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Most of the review here was about going through the first 3 pages of getting started, thinking how can we make it all better, but for now, let's take this in.

@aurorascharff
aurorascharff merged commit 03701be into canary Jul 20, 2026
67 checks passed
@aurorascharff
aurorascharff deleted the aurorascharff/setup-your-editor branch July 20, 2026 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants