Skip to content

Repository files navigation

freewili2-docs

Public user documentation for the FREE-WILi 2 handheld electronics multitool, built with Docusaurus 3.

Live site: https://docs.freewili.com/

This is user documentation — how to use the device — not developer or firmware documentation. It does not cover wire formats, API signatures, or argument tables; see freewili.com/onewili for that.

Running locally

npm install
npm run start   # local dev server with live reload
npm run build   # static production build into build/
npm run serve   # serve a build/ output locally

Requires Node.js >= 18.

Deployment

Pushing to main triggers .github/workflows/deploy.yml, which builds the site and publishes it to GitHub Pages. There is no manual deploy step.

Machine-owned files — do not hand-edit

The following are generated by the menutool product-docs generator and are overwritten on every regeneration run. Hand edits will be silently lost:

  • docs/features/
  • docs/panels/
  • sidebars.generated.js

Everything else under docs/ is hand-written.

License

No LICENSE file is currently present in this repository. That's a decision for the repo owner, not assumed here.

About

FreeWili 2 product documentation

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages