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: update README.md for examples/nextjs/starter #14

Merged
merged 3 commits into from
Jan 30, 2025

Conversation

BhumikP
Copy link
Contributor

@BhumikP BhumikP commented Jan 30, 2025

What

This PR includes documentation of Nextjs starter repo.

Related issue(s) :

  • Update readme for examples/nextjs/starter (and merge in DEVELOPMENT.md)

Why

It helps user to understand the repository structure

How

PR addresses issue of documentation for the users.

Checklist

  • I have read the Contribution Guidelines.
  • My code is tested to the best of my abilities.
  • My code passes all lints (ESLint, tsc, prettier etc.).
  • My code has detailed inline documentation.
  • I have added unit tests to verify the code works as intended.
  • I have updated the project documentation accordingly.

Copy link
Contributor

@ashutoshgautams ashutoshgautams left a comment

Choose a reason for hiding this comment

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

Middleware section just points to a separate doc without context, if it has to be like that maybe add it into learn more section.

examples/nextjs/starter/README.md Outdated Show resolved Hide resolved
examples/nextjs/starter/README.md Outdated Show resolved Hide resolved
examples/nextjs/starter/README.md Show resolved Hide resolved
@justlevine
Copy link
Collaborator

Middleware section just points to a separate doc without context, if it has to be like that maybe add it into learn more section.

This is a good point for enhancement, but its already 10.45PM IST, and I did as much other cleanup as I could. Feel free to follow up on this in future PRs.

@justlevine justlevine changed the title Docs/nextjs starter docs: update README.md for examples/nextjs/starter Jan 30, 2025
@justlevine justlevine dismissed ashutoshgautams’s stale review January 30, 2025 17:17

Manual cleanup, rest can be handled iteratively.

@justlevine justlevine merged commit 11c0361 into develop Jan 30, 2025
9 checks passed
@justlevine justlevine deleted the docs/nextjs-starter branch January 30, 2025 17:17
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