Own Pages site (manual, quality dashboard, benchmarks); remove internal notes #20

Merged
noah merged 3 commits from repo-cleanup into main 2026-11-03 10:10:23 -07:00
Owner
  • Internal notes out: AGENTS.md, HANDOFF.md, code-review-report.md, the implementation plan and the parity roadmap describe the internal bench. They move to the private workspace, are git-ignored here, and no doc links to them any more.
  • Project site: https://blueflare.gitea.bluefla.re/alkane-toolkit/ (gh-pages of this repo) gets an overview, the new manual (docs/manual), a code-quality dashboard, and the benchmark history moved off alkane-benchmarks.
  • Honest grade: the quality grade is now Clippy/rustfmt plus the line-coverage band (A 80, B 60, C 40, D 20). It was A whenever Clippy passed.
  • Data: main CI publishes quality.json (per-crate and per-file coverage) for the dashboard.
  • README: badges link to their pages.

Generated with Claude Code

- **Internal notes out:** AGENTS.md, HANDOFF.md, code-review-report.md, the implementation plan and the parity roadmap describe the internal bench. They move to the private workspace, are git-ignored here, and no doc links to them any more. - **Project site:** https://blueflare.gitea.bluefla.re/alkane-toolkit/ (gh-pages of this repo) gets an overview, the new manual (`docs/manual`), a code-quality dashboard, and the benchmark history moved off alkane-benchmarks. - **Honest grade:** the quality grade is now Clippy/rustfmt plus the line-coverage band (A 80, B 60, C 40, D 20). It was A whenever Clippy passed. - **Data:** main CI publishes `quality.json` (per-crate and per-file coverage) for the dashboard. - **README:** badges link to their pages. Generated with [Claude Code](https://claude.com/claude-code)
noah added 3 commits 2026-11-03 09:57:47 -07:00
AGENTS.md, HANDOFF.md, code-review-report.md, the implementation plan and the
aftermarket parity roadmap described the internal bench, its addresses and
in-house firmware; they now live in the private miner-firmware workspace and
are git-ignored here. The remaining docs and the fixture header no longer
point at them or at local infrastructure.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
https://blueflare.gitea.bluefla.re/alkane-toolkit/ is built from this repo
(gh-pages) after every main run: overview, manual, a quality dashboard and the
benchmark history, which no longer goes to alkane-benchmarks. The quality
grade is now Clippy/rustfmt plus the line-coverage band (the coverage badge's
own colour bands), not only the Clippy result, and main CI publishes the full
measurement (per-crate and per-file coverage, LOC per crate) as quality.json
for the dashboard. README badges link to their pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add the user manual
verify / verify-windows (pull_request) Successful in 5m2s
source / check (pull_request) Skipped
verify / verify (pull_request) Successful in 7m17s
b12c29b37f
Ten chapters in docs/manual, published at /manual/ on the project site:
getting started, scanning, the table, health icons, actions, settings and
credentials, restore to stock, export, command line, troubleshooting.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
noah merged commit ba0c71665a into main 2026-11-03 10:10:23 -07:00
noah deleted branch repo-cleanup 2026-11-03 10:10:23 -07:00
Sign in to join this conversation.