Docs ยท Guide
Adding a product hub
Use this checklist so new products feel native to the ecosystem without duplicating shell code or redesigning the homepage.
- Create folder:
/product-name/index.htmlusing/templates/product-hub.html. - Register product: add an entry to
/assets/data/products.json. - Search: add catalog entries to
/assets/data/search-index.json. - Shell: include
data-site-nav,data-site-footer, and/assets/js/site.js. - SEO: title, description, canonical, Open Graph, Twitter Card, JSON-LD + breadcrumb schema.
- A11y: one
h1, landmarks, focusable controls, meaningful link text. - IA links: related products module, sitemap entry, validation list update.
- Quality: run
python3 scripts/validate_static.pyand spot-check keyboard navigation.
Documentation standard per product
- Overview
- Features
- Examples
- FAQ
- Changelog / version
- Related products, articles, and downloads
Validation
Critical pages are listed in
scripts/validate_static.py. New public hubs must be added there and to sitemap.xml.