docs: prepare documentation for 1.0 release #267

Merged

jwilger merged 2 commits from docs/1.0-release-sweep into main 2026-05-19 07:14:10 -07:00

Conversation 3 Commits 2 Files changed 38 +337 -176

jwilger commented 2026-05-19 07:00:01 -07:00

Owner

Copy link

Why:

• Release-facing documentation, deployment assets, architecture notes, and opencode workflows had drifted from current runtime behavior.
• Operators need accurate commands, persistence/security guidance, and 1.0-ready support posture before the release PR.
• Version metadata is intentionally unchanged; release PR tooling owns the 1.0.0 version bump.

What:

• Refresh public docs for bot naming, CLI behavior, gateway env vars, SQLite persistence defaults, and 1.0 support wording.
• Align deployment examples, Helm/systemd assets, Prometheus rules, and Grafana dashboard with current runtime behavior and metrics.
• Update architecture/security docs, ADR supersession notes, crate docs, and opencode RGR workflow guidance.

Validation:

• just fmt
• just opencode-test
• cargo nextest run -p ar-chat -p ar-cli -p ar-gateway
• just test
• just build

Why: - Release-facing documentation, deployment assets, architecture notes, and opencode workflows had drifted from current runtime behavior. - Operators need accurate commands, persistence/security guidance, and 1.0-ready support posture before the release PR. - Version metadata is intentionally unchanged; release PR tooling owns the 1.0.0 version bump. What: - Refresh public docs for bot naming, CLI behavior, gateway env vars, SQLite persistence defaults, and 1.0 support wording. - Align deployment examples, Helm/systemd assets, Prometheus rules, and Grafana dashboard with current runtime behavior and metrics. - Update architecture/security docs, ADR supersession notes, crate docs, and opencode RGR workflow guidance. Validation: - `just fmt` - `just opencode-test` - `cargo nextest run -p ar-chat -p ar-cli -p ar-gateway` - `just test` - `just build`

jwilger added 1 commit 2026-05-19 07:00:01 -07:00

docs: prepare documentation for 1.0 release ... 8340a8de63

Why:\n- The release docs, deployment assets, architecture notes, and opencode workflows had drifted from the current runtime behavior.\n- Operators need copy-pasteable commands, accurate persistence/security guidance, and current 1.0 support posture before the release PR.\n\nWhat:\n- Refresh public docs, deployment examples, metrics assets, threat model, ADR metadata, CLI/help text, crate docs, and opencode RGR workflow docs.\n- Keep version metadata unchanged; release PR tooling owns the 1.0.0 version bump.\n\nValidation:\n- just fmt\n- just opencode-test\n- cargo nextest run -p ar-chat -p ar-cli -p ar-gateway\n- just test\n- just build

auto-review approved these changes 2026-05-19 07:01:54 -07:00

Dismissed

auto-review left a comment

Copy link

This PR updates documentation and deployment assets to align with the upcoming 1.0 release, ensuring accuracy in commands, environment variables, and support posture. The changes appear safe to merge, with no critical issues identified.

Walkthrough

• .opencode/agents/forgejo-feedback-processor.md: Updated permissions to deny access to certain sensitive files.
• .opencode/commands/: Introduced new commands like rgr_start and rgr_record_changed_diagnostic in workflows.
• AGENTS.md: Updated architecture notes to reflect new chat command aliases.
• CHANGELOG.md: Added notes for the 1.0.0 release preparation.
• README.md: Updated to reflect new chat command aliases.
• SECURITY.md: Updated disclosure timeline for the 1.x line.
• crates/ar-chat/src/handler.rs: Updated help text for new chat command aliases.
• crates/ar-cli/src/: Updated CLI commands to include a webhook subcommand.
• crates/ar-index/Cargo.toml: Updated description to include SQLite vector storage.
• crates/ar-llm/Cargo.toml: Updated description for OpenAI-compatible providers.
• crates/ar-review/src/lib.rs: Updated description to include RAG context construction.
• deploy/grafana/auto_review.dashboard.json: Added new metrics for failed: panic and failed: unknown.
• deploy/helm/: Updated deployment templates and values for new environment variables.
• deploy/prometheus/auto_review.rules.yaml: Added new metrics for failed: panic and failed: unknown.
• deploy/systemd/: Updated environment examples and service documentation for new paths.
• docs/ADR-0012-gate-semantic-review-behind-ci.md: Updated to reflect new chat command aliases.
• docs/ARCHITECTURE.md: Updated architecture notes for new chat command aliases.
• docs/CLI.md: Updated CLI documentation for new review command.
• docs/CRATES.md: Updated to include SQLite/in-memory vector stores.
• docs/DEPLOYMENT.md: Updated deployment documentation for new environment variables.
• docs/OPERATIONS.md: Updated operations documentation for new failure counters.
• docs/QUICKSTART.md: Updated quickstart documentation for new environment variables.
• docs/THREAT-MODEL.md: Updated threat model for vector/RAG store retention.
• docs/USER-GUIDE.md: Updated user guide for new chat command aliases.

LLM usage and cost

• Reasoning (gpt-4o) in=23639 out=2407 cost=$0.154300
• Cheap (gpt-4o-mini) in=458 out=49 cost=$0.000098
  Estimated total USD: $0.154398 via https://api.openai.com and https://api.openai.com

This PR updates documentation and deployment assets to align with the upcoming 1.0 release, ensuring accuracy in commands, environment variables, and support posture. The changes appear safe to merge, with no critical issues identified. ## Walkthrough - **.opencode/agents/forgejo-feedback-processor.md**: Updated permissions to deny access to certain sensitive files. - **.opencode/commands/**: Introduced new commands like `rgr_start` and `rgr_record_changed_diagnostic` in workflows. - **AGENTS.md**: Updated architecture notes to reflect new chat command aliases. - **CHANGELOG.md**: Added notes for the 1.0.0 release preparation. - **README.md**: Updated to reflect new chat command aliases. - **SECURITY.md**: Updated disclosure timeline for the 1.x line. - **crates/ar-chat/src/handler.rs**: Updated help text for new chat command aliases. - **crates/ar-cli/src/**: Updated CLI commands to include a `webhook` subcommand. - **crates/ar-index/Cargo.toml**: Updated description to include SQLite vector storage. - **crates/ar-llm/Cargo.toml**: Updated description for OpenAI-compatible providers. - **crates/ar-review/src/lib.rs**: Updated description to include RAG context construction. - **deploy/grafana/auto_review.dashboard.json**: Added new metrics for `failed: panic` and `failed: unknown`. - **deploy/helm/**: Updated deployment templates and values for new environment variables. - **deploy/prometheus/auto_review.rules.yaml**: Added new metrics for `failed: panic` and `failed: unknown`. - **deploy/systemd/**: Updated environment examples and service documentation for new paths. - **docs/ADR-0012-gate-semantic-review-behind-ci.md**: Updated to reflect new chat command aliases. - **docs/ARCHITECTURE.md**: Updated architecture notes for new chat command aliases. - **docs/CLI.md**: Updated CLI documentation for new review command. - **docs/CRATES.md**: Updated to include SQLite/in-memory vector stores. - **docs/DEPLOYMENT.md**: Updated deployment documentation for new environment variables. - **docs/OPERATIONS.md**: Updated operations documentation for new failure counters. - **docs/QUICKSTART.md**: Updated quickstart documentation for new environment variables. - **docs/THREAT-MODEL.md**: Updated threat model for vector/RAG store retention. - **docs/USER-GUIDE.md**: Updated user guide for new chat command aliases. ## LLM usage and cost - Reasoning (gpt-4o) in=23639 out=2407 cost=$0.154300 - Cheap (gpt-4o-mini) in=458 out=49 cost=$0.000098 Estimated total USD: $0.154398 via https://api.openai.com and https://api.openai.com

jwilger added 1 commit 2026-05-19 07:09:44 -07:00

fix(orchestrator): migrate review history cost column ... 5f195d037d

Why:\n- Existing gateway databases from before per-review cost attribution lack per_review_cost_usd.\n- Review posting succeeds but history recording fails on those deployments, causing repeated review bookkeeping errors.\n\nWhat:\n- Add an idempotent SQLite schema upgrade when opening review_history.\n- Cover the legacy-table path with a focused regression test.\n\nValidation:\n- cargo nextest run -p ar-orchestrator open_upgrades_legacy_table_without_cost_column_for_record_with_cost\n- cargo nextest run -p ar-orchestrator sqlite_history\n- just fmt\n- just test\n- just build

jwilger dismissed auto-review's review 2026-05-19 07:09:44 -07:00

Reason:

New commits pushed, approval review dismissed automatically according to repository settings

jwilger commented 2026-05-19 07:10:12 -07:00

Author

Owner

Copy link

Added a follow-up fix for the gateway log issue observed after this PR's review:

• fix(orchestrator): migrate review history cost column
• SqliteReviewHistory::open now upgrades legacy review_history tables that predate per_review_cost_usd.
• Added a focused regression test for opening an old table and then recording cost-aware history.

Validation:

• cargo nextest run -p ar-orchestrator open_upgrades_legacy_table_without_cost_column_for_record_with_cost
• cargo nextest run -p ar-orchestrator sqlite_history
• just fmt
• just test
• just build

Added a follow-up fix for the gateway log issue observed after this PR's review: - `fix(orchestrator): migrate review history cost column` - `SqliteReviewHistory::open` now upgrades legacy `review_history` tables that predate `per_review_cost_usd`. - Added a focused regression test for opening an old table and then recording cost-aware history. Validation: - `cargo nextest run -p ar-orchestrator open_upgrades_legacy_table_without_cost_column_for_record_with_cost` - `cargo nextest run -p ar-orchestrator sqlite_history` - `just fmt` - `just test` - `just build`

auto-review approved these changes 2026-05-19 07:12:01 -07:00

auto-review left a comment

Copy link

This PR updates documentation and deployment assets to align with the upcoming 1.0 release, ensuring accuracy in operator commands and support guidance. The changes appear safe to merge, with no critical issues identified.

Walkthrough

• Security and Permissions: Updated .opencode/agents/forgejo-feedback-processor.md to deny editing of sensitive files like .env and key files, enhancing security.
• Workflow Updates: Introduced new commands in TDD and RGR workflows, such as rgr_start and rgr_mark_green, requiring implementation and user training.
• Documentation: Extensive updates across multiple files to reflect new workflows, security measures, and deployment configurations, including ADR references and threat model expansions.
• Metrics and Monitoring: Added new metrics for failure types in Grafana and Prometheus configurations, ensuring comprehensive monitoring capabilities.
• Deployment and Configuration: Adjustments in Helm and systemd configurations to support container isolation and persistent storage paths, aligning with best practices for deployment.

LLM usage and cost

• Reasoning (gpt-4o) in=24470 out=1897 cost=$0.150805
• Cheap (gpt-4o-mini) in=10769 out=99 cost=$0.001675
  Estimated total USD: $0.152480 via https://api.openai.com and https://api.openai.com

This PR updates documentation and deployment assets to align with the upcoming 1.0 release, ensuring accuracy in operator commands and support guidance. The changes appear safe to merge, with no critical issues identified. ## Walkthrough - **Security and Permissions**: Updated `.opencode/agents/forgejo-feedback-processor.md` to deny editing of sensitive files like `.env` and key files, enhancing security. - **Workflow Updates**: Introduced new commands in TDD and RGR workflows, such as `rgr_start` and `rgr_mark_green`, requiring implementation and user training. - **Documentation**: Extensive updates across multiple files to reflect new workflows, security measures, and deployment configurations, including ADR references and threat model expansions. - **Metrics and Monitoring**: Added new metrics for failure types in Grafana and Prometheus configurations, ensuring comprehensive monitoring capabilities. - **Deployment and Configuration**: Adjustments in Helm and systemd configurations to support container isolation and persistent storage paths, aligning with best practices for deployment. ## LLM usage and cost - Reasoning (gpt-4o) in=24470 out=1897 cost=$0.150805 - Cheap (gpt-4o-mini) in=10769 out=99 cost=$0.001675 Estimated total USD: $0.152480 via https://api.openai.com and https://api.openai.com

jwilger merged commit a576da109e into main 2026-05-19 07:14:10 -07:00

jwilger deleted branch docs/1.0-release-sweep 2026-05-19 07:14:10 -07:00

jwilger referenced this pull request from a commit 2026-05-19 07:14:11 -07:00

docs: prepare documentation for 1.0 release (#267)

Sign in to join this conversation.

Reviewers

No reviewers

auto-review

Labels

Clear labels   

bug

  

discussion

  

enhancement

  

bug

Something is not working

  

duplicate

This issue or pull request already exists

  

enhancement

New feature

  

help wanted

Need some help

  

invalid

Something is wrong

  

question

More information is needed

  

wontfix

This won't be fixed

No labels

bug

discussion

enhancement

bug

duplicate

enhancement

help wanted

invalid

question

wontfix

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Slipstream/auto_review!267

No description provided.