Skip to content

TrickfireRobotics/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

122 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TrickFire Docs Framework

A shared documentation system for TrickFire Robotics member repositories. Member repos add trickfire-docs as a dev dependency, run trickfire-docs init to get scaffolding, and write docs in their own docs/ folder. A self-hosted server pulls from each repo and builds them into a single Docusaurus site at docs.trickfirerobotics.com.

Docs

Full documentation: docs.trickfirerobotics.com/trickfire-docs

  • Member guide — install, init, write content, and preview locally with trickfire-docs dev
  • Architecture — how the framework, CI, and hosted site fit together
  • Configuration reference — all docs.config.ts fields
  • Writing content — frontmatter, links, code blocks, admonitions, tabs
  • Deployment — server setup, Cloudflare tunnel, GitHub Actions runner (admin)

About

Multi-repo self-hosted documentation system for TrickFire that uses Docusaurus under the hood

Topics

Resources

License

Contributing

Stars

1 star

Watchers

0 watching

Forks

Contributors