webrecorder / browsertrix

Browsertrix is the hosted, high-fidelity, browser-based crawling service from Webrecorder designed to make web archiving easier and more accessible for all!
https://browsertrix.com
GNU Affero General Public License v3.0
170 stars 32 forks source link

Documentation Management Tech Debt #1601

Open Shrinks99 opened 6 months ago

Shrinks99 commented 6 months ago

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 commented 4 weeks ago

WOFF2 fonts are uploaded thanks to @emma-sg!