Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

guide: good heading rankings (MLEM ABCs) #233

Merged
merged 1 commit into from
Nov 23, 2022
Merged

Conversation

jorgeorpinel
Copy link
Contributor

The page title is an H1 so we can't really use more H1s. Also, there's lots of H2 headings in this page, which causes a super long (not useful) CONTENT nav.

p.s. there's a small engine bug when an H2 text is a repeat of an earlier heading: the scrolling jumps to the first instance, not to the H2 in question.

Specifically, rn https://mlem.ai/doc/object-reference/mlem-abcs#storage goes to the H1 before the H2 that causes the CONTENT nav entry:

image

Also, note that iterative/gatsby-theme-iterative#38 is manifested above, as the highlighted CONTENT nav entry is Artifact (should be Storage).

@jorgeorpinel jorgeorpinel requested a review from a team November 22, 2022 19:44
@shcheklein shcheklein temporarily deployed to mlem-ai-jorgeorpinel-pa-yjyzve November 22, 2022 19:45 Inactive
@jorgeorpinel jorgeorpinel added 🐛 type: bug Something isn't working. A: docs Area: user documentation (gatsby-theme-iterative) C: user-guide Content of /doc/user-guide labels Nov 22, 2022
@github-actions
Copy link

github-actions bot commented Nov 22, 2022

3914787

Link Check Report

There were no links to check!

Copy link
Contributor

@aguschin aguschin left a comment

Choose a reason for hiding this comment

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

Thanks @jorgeorpinel! Looks good to me!

@aguschin aguschin merged commit 3914787 into main Nov 23, 2022
@aguschin aguschin deleted the jorgeorpinel-patch-1 branch November 23, 2022 07:57
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: user-guide Content of /doc/user-guide 🐛 type: bug Something isn't working.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants