Skip to content

docs: consumer documentation set - #2

Merged
tanem merged 9 commits into
mainfrom
docs/consumer-docs
Jun 13, 2026
Merged

docs: consumer documentation set#2
tanem merged 9 commits into
mainfrom
docs/consumer-docs

Conversation

@tanem

@tanem tanem commented Jun 13, 2026

Copy link
Copy Markdown
Owner

Implements the approved consumer-docs spec (docs/superpowers/specs/2026-06-13-consumer-docs-design.md):

  • README reworked consumer-first (art-of-readme): pipeline diagram, real fixture-generated demo output (tables + JSON), why/install/quick-start, threat model. Licence + CI + codecov badges.
  • CONTRIBUTING and SECURITY mirroring the mt5-pnl-exporter house style, adapted to Go/GoReleaser (golden-file workflow, real-snapshot smoke test, tag-triggered releases, private vuln reporting).
  • GitHub Actions pinned to commit SHAs so SECURITY.md's supply-chain claim is true from day one; Renovate keeps them current.
  • Coverage upload to codecov on the ubuntu CI leg + badge (reporting only, no gate; CODECOV_TOKEN configured).
  • gitleaks pre-commit hook for secret-scan parity.
  • CLAUDE.md commands synced.

Demo output is generated from the test fixture, never hand-typed.

馃 Generated with Claude Code

@codecov

codecov Bot commented Jun 13, 2026

Copy link
Copy Markdown

Welcome to Codecov 馃帀

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered 鈽傦笍

Windows runners default to pwsh, which mangles the
`-coverprofile=coverage.out ./...` arguments into a phantom `.out`
package and fails the step even though every test passes. Pinning the
step to bash (available on the Windows runner via Git Bash) parses the
arguments the same way ubuntu and macos already do.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@tanem
tanem merged commit 6f3129a into main Jun 13, 2026
6 checks passed
@tanem
tanem deleted the docs/consumer-docs branch June 15, 2026 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant