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

clearer table of contents #559

Open
aghaynes opened this issue Aug 15, 2024 · 3 comments
Open

clearer table of contents #559

aghaynes opened this issue Aug 15, 2024 · 3 comments
Labels
docs 📚 Something to be adressed in docs and/or vignettes

Comments

@aghaynes
Copy link

Hey!
I just noticed that the table of contents seems to have gotten a bit messed up in the introduction_comparisons_2 vignette...
image

It seems that the callout is "stealing" the content of the sections that come after it...


image

Perhaps moving the callout above the "Hypothesis testing for slopes of numeric predictors" title would work better? 😄

@strengejacke
Copy link
Owner

No, I think the behaviour is that subsection / subheadings only appear when you scroll to the related section, to avoid to lengthy tables of content. This has changed recently in the package-down website features, so this should be intentional. :-)

@aghaynes
Copy link
Author

Sure, but the headings are not within the summary, are they? That's how it currently shows, as if you had done

# Hypothesis testing
...
# Summary of important topics
...
## is the linear trend significant
...
## is the difference linear trend significant
...
## etc

What you intended, I guess, is the following, which also makes more sense to me (the summary is just that, it's not a section itself per se, or certainly not a top one)...

# Hypothesis testing
...
## is the linear trend significant
...
## is the difference linear trend significant
...
## etc

(perhaps with the summary as a first second level section)

@strengejacke strengejacke reopened this Aug 16, 2024
@strengejacke
Copy link
Owner

I see. It's because the header of the summary box is declared as <h1>.

@strengejacke strengejacke added the docs 📚 Something to be adressed in docs and/or vignettes label Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs 📚 Something to be adressed in docs and/or vignettes
Projects
None yet
Development

No branches or pull requests

2 participants