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

Start index files with H1 #1200

Open
Tracked by #1210
wd60622 opened this issue Nov 14, 2024 · 0 comments
Open
Tracked by #1210

Start index files with H1 #1200

wd60622 opened this issue Nov 14, 2024 · 0 comments
Labels
docs Improvements or additions to documentation good first issue Good for newcomers

Comments

@wd60622
Copy link
Contributor

wd60622 commented Nov 14, 2024

Let's start the index.md files with an H1 tag to avoid the warnings building documentation builds.

We'd want to check to see if this switch results in rending of the documentation, like an inclusion of title in different location of toc, etc.

Here are the warnings that we are getting:

pymc-marketing/docs/source/getting_started/installation/index.md:1: WARNING: Document headings start at H2, not H1 [myst.header]
pymc-marketing/docs/source/getting_started/installation/index.md:39: WARNING: Document headings start at H2, not H1 [myst.header]
pymc-marketing/docs/source/index.md:39: WARNING: Document headings start at H2, not H1 [myst.header]
pymc-marketing/docs/source/index.md:56: WARNING: Document headings start at H2, not H1 [myst.header]
pymc-marketing/docs/source/index.md:111: WARNING: Document headings start at H2, not H1 [myst.header]
pymc-marketing/docs/source/index.md:130: WARNING: Document headings start at H2, not H1 [myst.header]

@wd60622 wd60622 added docs Improvements or additions to documentation good first issue Good for newcomers and removed Needs Triage labels Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant