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: Sub bullet point rendering incorrectly as numbered list #61838

Closed
Luceium opened this issue Feb 9, 2024 · 2 comments · Fixed by #62958
Closed

Docs: Sub bullet point rendering incorrectly as numbered list #61838

Luceium opened this issue Feb 9, 2024 · 2 comments · Fixed by #62958
Labels
Documentation Related to Next.js' official documentation. locked

Comments

@Luceium
Copy link

Luceium commented Feb 9, 2024

What is the improvement or update you wish to see?

In the authentication docs, there is a numbered list where each item should have bullet points underneath. Oddly, it's rendered as more numbers in the list but, shaded to be darker.
image

I found the code responsible at https://github.com/vercel/next.js/edit/canary/docs/02-app/01-building-your-application/09-authentication/index.mdx on lines 335 - 343.
I rendered the associated text on my end and it appears to be fine:
ex.

  1. topic 1
    • sub point
  2. topic 2

A solution could be adding one more space to each bullet point to bring the space count from 3 to 4 which helps with github's markdown.

Is there any context that might help us understand?

N/A

Does the docs page already exist? Please link to it.

https://nextjs.org/docs/app/building-your-application/authentication

@SaiGanesh21
Copy link
Contributor

Hi @Luceium. In the PR that I have raised it says that my branch is out of date with canary. In order to pull the latest changes to my branch should I run git merge canary or git pull origin canary --no-rebase ?

samcx added a commit that referenced this issue Mar 11, 2024
…rdered list (#62958)

On the Building Your Application: Authentication page, the formatting is
broken in the "Setting Up Middleware" section because the unordered list
is nested inside the ordered list. This is causing the unordered list
components to be numbered and throw off the ordering of the top level
list.

I made a tiny change to the markdown to make the top level steps h4
titles, and un-nested the unordered list's

Closes NEXT-61838
Fixes #61838

Co-authored-by: Sam Ko <sam@vercel.com>
Copy link
Contributor

This closed issue has been automatically locked because it had no new activity for 2 weeks. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Related to Next.js' official documentation. locked
Projects
None yet
2 participants