DM-41917: Improvements to the technote UI design #203
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
jonathansick
commented
Dec 1, 2023
•
jonathansick
commented
- Adopt the Source Sans 3 variable font (and ship it with technotes) to match branding also provide flexibility in typography. For example, the headings now use my more weights to reflect the heading hierarchy.
- Include links to the LTD editions dashboard
- Fix extra spaces in the author listing
- Improve typography on mobile (make section titles more compact)
- Style prompt directives to look like code blocks
jonathansick
force-pushed
the
tickets/DM-41917
branch
from
0071e48 to
697f34b
Compare
This provides some design improvements for technotes.
Add a change edition link to the source sidebar; add a custom source sidebar component to do so.
Make both the version and date updated link to other versions. I hope that it's implied that a link on information related to a version will let you find other versions; but we'll find out through user feedback if this proves not to be clear.
The variable font (in .ttf.woff2 format) is obtained from https://github.com/adobe-fonts/source-sans/tree/release/WOFF2/VF These are version 3.052 Webpack takes responsibility for loading the webfont and then ensuring that the CSS points to the right URL for it. In the course of doing this, it also renames the font assets with a hash. To accomodate this, I've added added extend_static_paths_with_asset_extension to the config utilities functions. This helper function lets us glob the paths in assets/ with a matching extension. This is needed because webpack generates hashed filenames for the webfont assets. Also, to ensure the relative paths work I've also changed to webpack settings so that the rubin-technote.css is output to the root of assets/, which is where webpack also deposits the font files.
This lets us make the title slightly bold. And also let the headings get bolder as their size becomes smaller.
- Use a 600 weight for the section headings to give them a subtle distinction from regular text; also turn into uppercase - Increase weight of the version and date links in the article header, also to provide slight emphasis against the labels.
These take styles that are slightly different than code blocks.
jonathansick
force-pushed
the
tickets/DM-41917
branch
from
697f34b to
636cad2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.