Release: Wombat

Wombat is the current DocsHub architecture.

staxdash documentation

Choose a version

Current

Version Current

StaxDash Staff Onboarding #

Welcome to StaxDash. This page gets a new engineer from “clone the repos” to “shipping a release” following the org conventions. Read the StaxDash Organization Standards first for the rules we work under.

Accounts and access #

GitHub org: StaxDash — you are added to the relevant team with write access to your projects.
DocsHub / docs: documentation lives in the DocsHub repo under src/staxdash/ and publishes to docs.staxdash.com.
Website: the staxdash-website repo publishes to staxdash.com.

Setting up a repository #

Clone the repo (e.g. staxsys) and the DocsHub repo (for docs).
For Node projects, install Node.js >= 18.15 (22 recommended); the CI matrix covers both.
For StaxOffice (Python), create a venv and pip install -e ".[dev]".
Run the tests: npm test (Node) or python -m unittest discover -s tests -v (Python).

Where the code lives #

Repo	What it is	Stack
`staxsys`	Terminal system monitor	Node.js / blessed
`staxping2`	Terminal network diagnostics	Node.js
`StaxOffice`	StaxSuite launcher + desktop tools	Python / PySide6
`DocsHub`	Source of truth for docs	Eleventy
`staxdash-website`	Brand site	Eleventy / Tailwind
`homebrew-tap`	Homebrew formulas for the tools	Shell

Working (standards summary) #

Docs are the source of truth. Update docs in DocsHub/src/staxdash/ rather than duplicating in READMEs; then npm run sync:terminal from the website repo to refresh the terminal snapshot.
Commit messages: conventional prefixes (feat:, fix:, docs:, …).
Versioning: SemVer. Release = tag vX.Y.Z; the CI builds and attaches binaries automatically.
Merge discipline: feature → staging → (24h cooling + full testing) → main. No end-of-window merges.
Small footprint: prefer native OS APIs, one runtime dependency or fewer.

The test matrix #

Every Node repo runs CI on Linux/macOS/Windows, Node 18 & 22, on push and pull request. For a release, run the full functionality test (not just unit tests): core flows, config, persistence, build output, across the OSes you can reach.

Making a release #

Update CHANGELOG.md and bump the version.
Run the full functionality test.
Tag vX.Y.Z and push — the release workflow builds and attaches binaries.
For Homebrew-available tools, update the tap formula (node scripts/set-shas.js <tool> vX.Y.Z).
Update DocsHub: bump products.js / staxdash-terminal-index.js lines and the last_reviewed on affected pages; run npm run check.
Optionally refresh the website terminal snapshot via sync:terminal.

Reporting issues and security #

Bugs and features: open an issue in the project repo.
Security: follow the repo SECURITY.md (private disclosure). Do not open a public issue for a vulnerability.

Getting help #

Ask in the org’s internal channel, or open a draft PR early for review. When in doubt, follow the StaxDash Organization Standards and the ZFordDev root standards.