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

Adapt Next.js "Getting Started" guide to Next.js App Router folder structure #99

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

arnaugomez
Copy link

The App Router folder structure is the default option when creating a new Next.js project nowadays. However, the Tiptap Next.js "Getting Started" guide only mentions the Pages Router folder structure.

I suggest the "Getting Started" guide mention the App Router folder structure by default, and the Pages Router folder structure as an alternative option.

Changes Overview

Mention both the App router folder structure (default option) and the Pages Router folder structure (alternative option) in the Next.js "Getting Started" guide.

Implementation Approach

Modify the markdown file.

Testing Done

Verification Steps

  1. Open local dev server (npm run dev)
  2. Visit the site: http://localhost:3000/editor/getting-started/install/nextjs
  3. Check the changed content.

Additional Notes

None

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

None

Copy link

vercel bot commented Feb 7, 2025

@arnaugomez is attempting to deploy a commit to the Tiptap Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Feb 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tiptap-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 27, 2025 4:39pm

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.

1 participant