feat(docs): add header links #2882
Conversation
github-actions
bot
added
the
pkg: documentation
✅ Deploy Preview for brilliant-pasca-3e80ec ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@blair, thanks. I'm gonna wait for the doc updates to be in before addressing this because all our links are changing. But it's a good suggestion. So I'll pick it up when our new docs structure is good to go. |
|
@BlairCurrey @JoblersTune Exchange rates, webhook, fees, IdP... these all have their own page in the new doc structure. We might not need this issue, but def leave it open until the new structure is live just in case. |
@melissahenderson I believe this is less about any specific item and more about an approach. I think what Blair is suggesting here is that we should make it easy to link directly to any heading on a page, not just the page itself. Once the docs are updated I'm happy to dive in and check it out. |
|
@melissahenderson @BlairCurrey @JoblersTune Should we add this to the new set of docs? |
|
Was the issue originally because the page was in mobile view, so the page's table of contents didn't appear on the right side of the screen? 
@BlairCurrey Would you have had this issue if the page's table of contents was more apparent? 
|
|
I'm gonna take a proper look at this today |
There was a problem hiding this comment.
Thanks for this @BlairCurrey. It's great. Can we maybe just edit the styling a bit because otherwise we have an underline on top of our highlight underlines and it looks odd.
How about this instead?
/* Heading styles */
.sl-markdown-content :is(h1, h2, h3, h4, h5, h6) > a {
color: inherit;
text-decoration: none;
transition: color 0.2s ease-in-out;
}
.sl-markdown-content :is(h1, h2, h3, h4, h5, h6) > a:hover {
color: var(--sl-color-accent-high);
}
There was a problem hiding this comment.
makes sense. updated.
@melissahenderson I do not recall if I was in mobile view (or just smaller viewport on desktop). I didn't think to use the outline in any case. And actually in a smaller viewport I didn't realize where it was. I see how the outline can be used to the same effect. Personally I'm just used to the convention of the headers being links - it feels like a more direct way to get the link when reading/scanning the document. |
|
Great, thanks. Any idea why the auth tests are failing? |
Something intermittent... tests timed out for some reason. Fine now after re-running. |
Changes proposed in this pull request
Screen.Recording.2024-08-22.at.12.43.38.AM.mov
Context
I wanted to link to a specific section and found it annoying to do so without this.
Checklist
fixes #number