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

refactor: use Public Sans and Reddit Mono on PAPI docs site #14662

Merged
merged 4 commits into from
Aug 27, 2024

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Mar 14, 2024

Overview

Updating the Python API docs to use our design system proportional and fixed-width fonts.

Test Plan

  • public sansbox
  • tested on macOS Safari and Chrome, on computers with and without the fonts installed locally

Changelog

  • Open Sans -> Public Sans
  • using Reddit Mono for monospace
  • other minor CSS tweaks

Review requests

is it pretty?

should we also get rid of Akko H1s?

is there a way to get rid of the 1px of white space between the light grey background box of <a><code> and the dotted border below it? i've tried every CSS kludge i know of.
Screenshot 2024-08-19 at 1 37 30 PM

also need testing assistance on

  • Windows Chrome
  • Windows Edge
  • Linux browsers

Risk assessment

low

@ecormany ecormany requested a review from shlokamin March 14, 2024 20:52
Copy link

codecov bot commented Mar 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.34%. Comparing base (1e18315) to head (0e1c9b3).
Report is 316 commits behind head on edge.

❗ Current head 0e1c9b3 differs from pull request most recent head 061110e. Consider uploading reports for the commit 061110e to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #14662   +/-   ##
=======================================
  Coverage   67.34%   67.34%           
=======================================
  Files        2485     2485           
  Lines       71411    71411           
  Branches     9036     9036           
=======================================
  Hits        48093    48093           
  Misses      21173    21173           
  Partials     2145     2145           
Flag Coverage Δ
g-code-testing 92.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@ecormany ecormany changed the base branch from edge to chore_release-8.0.0 August 19, 2024 15:53
@ecormany ecormany changed the title refactor: use Public Sans and Roboto Mono on PAPI docs site refactor: use Public Sans and Reddit Mono on PAPI docs site Aug 19, 2024
@ecormany ecormany marked this pull request as ready for review August 19, 2024 17:40
@ecormany ecormany requested a review from a team as a code owner August 19, 2024 17:40
}

pre, tt, code {
font-size: 0.9em;
Copy link
Contributor

@koji koji Aug 19, 2024

Choose a reason for hiding this comment

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

need to use the parent element as the basis?
if not, recommend you use rem instead em


/* classes for API Reference docstring signatures */
.sig, .sig-name, code.descname, .sig-prename, .optional, .sig-paren {
font-size: 1em;
Copy link
Contributor

Choose a reason for hiding this comment

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

same question

Copy link
Contributor

@koji koji left a comment

Choose a reason for hiding this comment

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

nice!
font was changed from Open Sans to Public Sans

@ecormany
Copy link
Contributor Author

Going ahead and merging this so I can continue on bigger style changes (new top and bottom nav). If there are any issues caused by this PR, I can address it as part of that or in a separate followup.

@ecormany ecormany merged commit d65676e into chore_release-8.0.0 Aug 27, 2024
22 checks passed
@ecormany ecormany deleted the docs-public-sans branch October 16, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants