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.

Sign up for GitHub

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

Jump to bottom

Update README.md #48717

Merged
merged 24 commits into from
Feb 5, 2024
Merged

Update README.md #48717

merged 24 commits into from
Feb 5, 2024

Conversation

Ishaan2053
Copy link
Contributor

@Ishaan2053 Ishaan2053 commented Apr 22, 2023 •
edited
Loading

Improving Documentation

The following changes have been made to the official repository's Readme.md:

  • Shortened link text across the readme.
  • Added additional descriptions for more details.
  • Added bold text to highlight emphasis on important topics
  • Changed heading sizes to indicate first headings (h1) for each section instead of second headings (h2) which was previously being used
  • Merged 'Who is using Next.js?' section with 'Getting Started' section for a more professional, cleaner look.

The following changes have been made to the repository's Contribution docs:

  • Fixed two typos in the docs

@Ishaan2053 Ishaan2053 requested review from a team as code owners December 31, 2023 10:06
@Ishaan2053 Ishaan2053 requested review from timeyoutakeit and delbaoliveira and removed request for a team December 31, 2023 10:06
samcx
samcx requested changes Jan 17, 2024
View reviewed changes
packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
@Ishaan2053 @samcx
Update packages/next/README.md
58b7730 
Co-authored-by: Sam Ko <sam@vercel.com>
Ishaan2053 and others added 4 commits January 17, 2024 20:31
@Ishaan2053 @samcx
Update packages/next/README.md
80295c8 
Co-authored-by: Sam Ko <sam@vercel.com>
@Ishaan2053 @samcx
Update packages/next/README.md
6d69ce3 
Co-authored-by: Sam Ko <sam@vercel.com>
@Ishaan2053 @samcx
Update packages/next/README.md
d81a67a 
Co-authored-by: Sam Ko <sam@vercel.com>
@Ishaan2053 @samcx
Update packages/next/README.md
27782af 
Co-authored-by: Sam Ko <sam@vercel.com>
@samcx samcx enabled auto-merge (squash) January 18, 2024 20:33
@Ishaan2053 @samcx
Update packages/next/README.md
4df56d5 
Co-authored-by: Sam Ko <sam@vercel.com>
auto-merge was automatically disabled January 19, 2024 04:41

Head branch was pushed to by a user without write access

@samcx samcx self-requested a review January 19, 2024 06:05
@samcx samcx enabled auto-merge (squash) January 19, 2024 08:59
@samcx samcx self-requested a review January 24, 2024 21:04
samcx
samcx requested changes Jan 24, 2024
View reviewed changes
Copy link
Member

@samcx samcx left a comment

Choose a reason for hiding this comment

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

@Ishaan2053 Can you try running prettier on the file again? The lint test is not passing because of prettier issues.

auto-merge was automatically disabled February 4, 2024 08:12

Head branch was pushed to by a user without write access

@Ishaan2053
Copy link
Contributor Author

@Ishaan2053 Can you try running prettier on the file again? The lint test is not passing because of prettier issues.

I've done it on both Readme.md and 01-contribution-guide.mdx

@samcx samcx self-requested a review February 4, 2024 23:05
@samcx
Copy link
Member

samcx commented Feb 4, 2024

@Ishaan2053 01-contribution-guide.mdx I believe was not ran correctly—there should not be semi-colons.

@samcx samcx merged commit d245079 into vercel:canary Feb 5, 2024
28 of 33 checks passed
@samcx samcx mentioned this pull request Feb 5, 2024
Merged
samcx added a commit that referenced this pull request Feb 5, 2024
@samcx
chore: update README.md (#61650)
47c74dc 
## Description

On [second thought](#48717), the
previous heading size of (`##`) looks better.

Closes NEXT-2358
@AhmedBaset AhmedBaset mentioned this pull request Feb 6, 2024
Merged
samcx pushed a commit that referenced this pull request Feb 6, 2024
@AhmedBaset
Fix duplicate line in README (#61691)
0a796d6 
#48717 duplicated the /learn course link in README.md
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@makstyle119 makstyle119 makstyle119 left review comments

@samcx samcx samcx approved these changes

@timneutkens timneutkens Awaiting requested review from timneutkens

@ijjk ijjk Awaiting requested review from ijjk

@shuding shuding Awaiting requested review from shuding

@huozhi huozhi Awaiting requested review from huozhi

@feedthejim feedthejim Awaiting requested review from feedthejim

@ztanner ztanner Awaiting requested review from ztanner

@wyattjoh wyattjoh Awaiting requested review from wyattjoh

@timeyoutakeit timeyoutakeit Awaiting requested review from timeyoutakeit timeyoutakeit was automatically assigned from vercel/devex

@delbaoliveira delbaoliveira Awaiting requested review from delbaoliveira delbaoliveira was automatically assigned from vercel/devex

Assignees
No one assigned
Labels
locked type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Ishaan2053 @samcx @makstyle119 @ijjk @delbaoliveira