Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Margin footnotes convention & cleanup#244

Merged
validbeck merged 25 commits intomainvalidmind/documentation:mainfrom
beck/sc-5288/explore-alternative-footnotes-options-forvalidmind/documentation:beck/sc-5288/explore-alternative-footnotes-options-forCopy head branch name to clipboard
Jul 10, 2024
Merged

Margin footnotes convention & cleanup#244
validbeck merged 25 commits intomainvalidmind/documentation:mainfrom
beck/sc-5288/explore-alternative-footnotes-options-forvalidmind/documentation:beck/sc-5288/explore-alternative-footnotes-options-forCopy head branch name to clipboard

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Jul 9, 2024

Internal Notes for Reviewers

For sc-5288, I looked into using Quarto's footnotes functionality to clean up our margin footnotes.

Footnotes

Screenshot 2024-07-09 at 1 30 08 PM

  • Established a net-new convention in the style guide (I decided that doing it "right" with a clean and easy to locate footnotes section at the bottom was the best way to go, instead of having to convert pages with inline footnotes if additional ones ever need to be added)
  • Edited all footnotes to follow this convention
  • Simplified footnotes where appropriate, and changed the ones that were before punctuation to after to follow common style guide conventions
  • Adjusted the anchor off-set to accommodate for the footnotes (as the table of contents takes up some more space, and will cover a footnote if you jump to it)
Old New
Screenshot 2024-07-09 at 1 31 40 PM Screenshot 2024-07-09 at 1 31 45 PM
Screenshot 2024-07-09 at 1 33 40 PM Screenshot 2024-07-09 at 1 33 35 PM

Cosmetic changes

Navlinks

  • Snazzy ValidPink underline animation in the top-nav & table of contents (they are they same class), including in the Developer Framework drop down
  • Pink hover state for sidenav links
Old New
old_navigation new_navigation

Inline links

  • Increased the padding for inline links so the underline is not bumped up against the text, and overlapping with underscores or letters with hanging descenders
  • Thickened them up a little to match the newer modern navigation
Old New
old_inline-links new_inline-links

Announcement banner

  • Snazzy new ValidMind styled announcement banner, dismissable by users
  • This is set in _quarto.yml under website.announcement and the fun styling is determined in styles.css

announcement

@validbeck validbeck added the internal Not to be externalized in the release notes label Jul 9, 2024
@validbeck validbeck self-assigned this Jul 9, 2024
@validbeck validbeck requested review from noosheenv and nrichers July 9, 2024 20:50
nrichers

This comment was marked as outdated.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Looks awesome, @validbeck! SHIP IT. 🚢🚢🚢

I especially like that your new animated links make use of the added whitespace — it's suddenly all coming together. I suspect you had a plan all along.

(Also, wouldn't it just be easier to go ALL pink now instead of getting there bit by bit? Just make ALL THE THINGS PINK.) 🩷🩷🩷

Also, very important, the new pink dashes on hover remind me of this:

@validbeck validbeck merged commit e920cda into main Jul 10, 2024
@validbeck validbeck deleted the beck/sc-5288/explore-alternative-footnotes-options-for branch July 10, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.