Skip to content

Align v1.1.0 release documentation - #22

Merged
lmdixon23 merged 1 commit into
mainfrom
release-v1.1.0-consistency-20260727
Jul 27, 2026
Merged

Align v1.1.0 release documentation#22
lmdixon23 merged 1 commit into
mainfrom
release-v1.1.0-consistency-20260727

Conversation

@lmdixon23

Copy link
Copy Markdown
Owner

Summary

  • update the RAG Assistant README to reflect the existing optional cross-encoder reranker, the current 19-test/four-file suite, the reranker evaluation command, and the measured five-case smoke result
  • rewrite RESULTS.md so CI inventory, smoke coverage, measured outputs, and limitations are stated consistently
  • add an RLVR landing page connecting regularized_operator_zoo and grpo_minimal without overstating runtime delegation or absorbing the separate RLVR Operator Series

Why

The release-facing documentation had drifted from the merged implementation and current CI structure. It still described reranking as absent, reported obsolete test and Rust-crate counts, listed protected local work as public smoke coverage, and lacked an RLVR entry point.

This PR repairs those inconsistencies before the v1.1.0 release gate.

Scope

Exactly three documentation files:

  • RESULTS.md
  • ai_engineering/rag_assistant/README.md
  • ai_engineering/rlvr/README.md

No source code, workflows, protected local paths, tags, or release artifacts are changed.

Validation

  • Windows PowerShell 5.1 parser and disposable Git fixture passed
  • exact three-file commit boundary and whitespace checks passed
  • RAG Assistant: 19 tests passed, no skips
  • LLM eval harness bridge: 2 tests passed, no skips
  • relative Markdown links, CI inventory, smoke-script count, and RAG test-file count validated
  • protected untracked paths remained unchanged
  • branch head verified at 8d72c748e46a07720d585689857b9cffc7140196

Limitations retained explicitly

@lmdixon23
lmdixon23 marked this pull request as ready for review July 27, 2026 10:10
@lmdixon23
lmdixon23 merged commit 968e1b4 into main Jul 27, 2026
21 checks passed
@lmdixon23
lmdixon23 deleted the release-v1.1.0-consistency-20260727 branch July 27, 2026 15:07
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