QA checklist for docs site format and functionality

Jump to bottom

Hillary Fraley edited this page Nov 22, 2022 · 1 revision

For any PR that involves a change to docs site format or functionality (including Hugo version updates), make sure to QA the following elements in the Heroku review app:

Page-level platform switchers
Scrolling on the page
Floating (right nav) TOC highlighting and links
Links inside shortcodes (like notes)
Images
Code blocks and switchers
Offline docs PDF generation (including link-based navigation and proper image display)