Back to Tutorials

Publishing generated hardware files into the docs site

Set up a simple convention so another repository can push schematics, code, and dimension exports without changing the frontend.

Apr 6, 20267 min readMaintainers
github actionsartifactsdocs pipeline

Use stable folder names

The frontend should not need to know how KiCad, firmware, or PDF generation works. It only needs predictable folders that will exist for each project slug.

This starter keeps those folders under public/generated/<project-slug>/ so GitHub Pages can serve them directly after the static export is built.

Let automation own the files

Treat the documentation app as the presentation layer. Another repository or workflow should be free to publish fresh files into the generated folders without touching React components or route code.

That separation is what will make the eventual move to Django easier too, because the content structure stays stable while the backing system changes.

  • board-dimensions for mechanical exports
  • code for firmware bundles and examples
  • data-sheets and datasheets for vendor PDFs
  • schematics for rendered diagrams and source snapshots

Link from project pages first

Project pages are the best place to expose generated files because that is where an engineer already expects to find the latest board context.

From there, tutorials, news posts, and product pages can reference the same project instead of duplicating download logic everywhere.