browsertrix icon indicating copy to clipboard operation
browsertrix copied to clipboard

Documentation Management Tech Debt

Open Shrinks99 opened this issue 11 months ago • 1 comments

Context

Our documentation is written using Material for MKDocs, is written per-tool, and included in each repo. This means that anyone using the tools also has a local copy of our docs which is great for lowering the bar to contributing and ease of use (reading while offline with no extra work!)

Now that we have three different MKDocs sites though, some issues have arisen!

  1. I have written a bunch of custom CSS for the Browsertrix docs and will likely write more in the future! This gives us a few custom styling elements, applies our theme colours, and applies our brand typefaces. This is currently duplicated accross the three repos (Browsertrix, Browsertrix Crawler, and ReplayWebpage) which isn't great for keeping this code identical accross all three.
  2. (From Ilya) The fonts are kinda big... Fonts are essentially software dependencies so same management issue as above, Inter actually needs an update!

Tasks

  • [ ] @Shrinks99 Split any per-tool CSS styles from global CSS that should be applied to the other docs
  • [x] @vnznznz Set up a bucket to host the fonts for all our online sites
  • [x] @Shrinks99 License and upload Konsole
  • [ ] @Shrinks99 Update docs CSS to use Konsole for app titles
  • [ ] @Shrinks99 Update Inter to V4
  • [ ] Markdown linting!

Shrinks99 avatar Mar 15 '24 18:03 Shrinks99

WOFF2 fonts are uploaded thanks to @emma-sg!

Shrinks99 avatar Aug 21 '24 20:08 Shrinks99