Skip to content

Align repo state with v0.6.0 and rewrite README for accuracy - #19

Merged
DJLougen merged 1 commit into
mainfrom
fix/v0.6.0-readme-and-repo-state
Jun 12, 2026
Merged

Align repo state with v0.6.0 and rewrite README for accuracy#19
DJLougen merged 1 commit into
mainfrom
fix/v0.6.0-readme-and-repo-state

Conversation

@DJLougen

Copy link
Copy Markdown
Owner

Summary

Aligns the repository with the v0.6.0 release and rewrites the README to reflect the real current state and complexity of the project. This addresses the drift around the v0.6.0 commit (which still reported 0.5.0 in several places), a couple of broken-markdown / CI bugs, and a README that had grown inaccurate.

README rewrite

The old README documented a 6-file sketch and an API that no longer matches the code. It now reflects what actually ships:

  • Architecture / complexity — the real ~28-module surface: orchestration (stack, async_stack), memory (rust_brain with HLC, semantic_search), compression (rule_fast), learning (feedback, policy_updater, ab_test), security (auth JWT/RBAC, encryption, model_registry signed-joblib, audit_export, schemas), reliability (circuitbreaker, ratelimit, health), distributed (gossip, deployment), observability (telemetry, tracing, hardware), plus plugins, streaming, llm, config.
  • Accurate public APIRouteDecision(tool/args/confidence/escalated/source) (was .action); step() -> {decision, compressed, stats} (was {…, memories, metadata}); recall() -> value; update_policy() -> bool; from hive.feedback import OutcomeType.
  • Correct compression labelsCORE/DISTILL/COMPACT/DROP/STALE/ESCALATE (the README invented CRITICAL/DEBUG/TOOL_OUTPUT/ERROR/INFO).
  • Fixed two code-fence breaks that swallowed the Online Learning / Causal Memory and Development sections.
  • Fixed reproduce paths (scripts/…, not hive/scripts/…).
  • Honest results — replaced the contradictory ROI/case-study/energy claims with the real committed SWE-bench-lite A/B (docs/benchmarks/swebench-lite/hive-20260611T200319Z.json: 85% resolve, −91.7% LLM calls). Routing accuracy is framed as in-distribution with an explicit OOD caveat.

Version drift

  • pyproject.toml: restored the missing [build-system] table and removed a stray top-level version key; [project].version 0.5.00.6.0.
  • hive.__version__, the FastAPI server, and the Helm chart → 0.6.0.
  • eval-result issue template placeholder → v0.6.0.

hive-cpp is a separately-versioned native component and is intentionally left at 0.5.0 — the pasted fix-up script bumped it, which would conflate the component's semver with the meta-package.

Citation / CI

  • .github/citation.cff was JSON with non-CFF fields (citationFormat, schemastore $schema); rewritten as valid CFF 1.2.0 YAML.
  • CI now validates it with cffconvert --validate instead of json.load(...) — fixes "CI validating .cff as JSON".

Changelog

  • Added honest ## [0.6.0] entries to CHANGELOG.md and RELEASE_NOTES.md.

Verification

  • pytest: 185 passed, 8 skipped (skips are optional-dependency integration tests).
  • cffconvert --validate -i .github/citation.cffvalid according to schema 1.2.0.
  • README code fences balanced (16/16); all in-repo README links resolve.

Deliberate non-goals

  • The dated historical docs (docs/compliance-checklist.md, soc2-evidence.md, incident-response-runbook.md, rlhf-roadmap.md, MIGRATION.md, USAGE.md) still say 0.5.0 / 2026-06-02. Blanket-bumping their as-of dates would falsify them; left for a separate docs pass if wanted.
  • The 07a1c75 commit message's "v0.3 definition of done" line is immutable history on main and is not rewritten (would require a force-push to the default branch).

README — reflect the real current state and complexity:
- Rewrite around the actual ~28-module surface (orchestration, memory, learning,
  security, reliability, distributed, observability, deployment) instead of the
  6-file sketch that listed rust_brain.py / rule_fast.py (both are packages).
- Correct the public API to the real types: RouteDecision(tool/args/confidence/
  escalated/source) not .action; step() -> {decision, compressed, stats};
  recall() -> stored value; update_policy() -> bool; OutcomeType from hive.feedback.
- Correct compression labels to CORE/DISTILL/COMPACT/DROP/STALE/ESCALATE.
- Fix two broken code fences (Online Learning/Causal Memory; Development) that
  swallowed whole sections.
- Fix wrong reproduce paths (scripts/, not hive/scripts/).
- Replace the unmeasured/contradictory ROI, case studies, and energy headline
  with the real committed SWE-bench-lite A/B (85% resolve, -91.7% LLM calls).

Version drift:
- pyproject.toml: restore the missing [build-system] table and drop a stray
  top-level version key; [project].version 0.5.0 -> 0.6.0.
- hive.__version__, FastAPI server, and Helm chart 0.5.0 -> 0.6.0.
- eval-result issue template placeholder -> v0.6.0.
  (hive-cpp is a separately-versioned component and is intentionally left at 0.5.0.)

Citation / CI:
- Rewrite .github/citation.cff as valid CFF 1.2.0 (it was JSON with non-CFF fields).
- CI validates it with cffconvert instead of json.load (fixes "validating .cff as JSON").

Changelog:
- Add honest v0.6.0 CHANGELOG and RELEASE_NOTES entries.

Verified: 185 passed / 8 skipped (optional deps) locally; cffconvert --validate OK;
README code fences balanced; all README links resolve.
@DJLougen
DJLougen merged commit aecf451 into main Jun 12, 2026
7 checks passed
@DJLougen
DJLougen deleted the fix/v0.6.0-readme-and-repo-state branch June 12, 2026 13:43
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