Slipstream/auto_review
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases 27 Packages Activity Actions

docs: consolidate operator documentation #172

Merged
jwilger merged 2 commits from docs/quickstart-cleanup into main 2026-05-08 22:23:11 -07:00
Conversation 2 Commits 2 Files changed 44 +982 -2265
jwilger commented 2026-05-08 22:03:34 -07:00
Owner
Copy link

Summary

  • Rework the README around a short project pitch plus TL;DR install/run flow and update status to Beta.
  • Consolidate quickstart, deployment, CLI, crate, and benchmark docs under docs/ while removing stale root, crate, bench, and deploy README files.
  • Refresh doc references, release/tooling contracts, Helm metadata, and the CLI docs contract test to match the new documentation layout.

Verification

  • git diff --check
  • nix develop --command cargo test -p ar-cli readme_documents_every_subcommand
  • nix flake check --print-build-logs

PR artifacts for 9dc5d87feb:

Docker image: git.johnwilger.com/jwilger/auto_review/ar-gateway-pr:pr-172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c
binary download: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c/auto-review-pr-172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c-linux-x86_64.tar.gz
SHA256SUMS: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c/SHA256SUMS

## Summary - Rework the README around a short project pitch plus TL;DR install/run flow and update status to Beta. - Consolidate quickstart, deployment, CLI, crate, and benchmark docs under `docs/` while removing stale root, crate, bench, and deploy README files. - Refresh doc references, release/tooling contracts, Helm metadata, and the CLI docs contract test to match the new documentation layout. ## Verification - `git diff --check` - `nix develop --command cargo test -p ar-cli readme_documents_every_subcommand` - `nix flake check --print-build-logs` <!-- auto_review:artifact-links:start --> PR artifacts for 9dc5d87feb5db9df21a6d7a96bbf66637492a12c: Docker image: git.johnwilger.com/jwilger/auto_review/ar-gateway-pr:pr-172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c binary download: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c/auto-review-pr-172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c-linux-x86_64.tar.gz SHA256SUMS: https://git.johnwilger.com/api/packages/jwilger/generic/auto-review-pr/172-9dc5d87feb5db9df21a6d7a96bbf66637492a12c/SHA256SUMS <!-- auto_review:artifact-links:end -->
docs: consolidate operator documentation
All checks were successful
CI / Verify PR with nix flake check (pull_request) Successful in 4m51s
Details
CI / Build PR artifacts (no token) (pull_request) Successful in 55s
Details
CI / Request auto_review semantic review (pull_request) Successful in 6s
Details
auto_review auto_review: no findings
CI / Publish PR artifact packages (pull_request) Successful in 45s
Details
68ac6e9e77
auto-review approved these changes 2026-05-08 22:09:53 -07:00
Dismissed
auto-review left a comment
Copy link

The PR consolidates documentation by moving various README files into a centralized docs/ directory, updating references, and removing outdated files. This change appears safe to merge, but ensure that all necessary information is retained in the new documentation structure.

Walkthrough

  • Documentation Consolidation
    • Moved various README files into a centralized docs/ directory.
    • Updated references in code and documentation to point to the new locations.
    • Removed outdated README files from individual crates and deployment directories.
    • Ensure that all necessary information from the removed files is retained in the new documentation structure.
  • CI Configuration
    • Updated .forgejo/workflows/ci.yml to reference the new documentation paths.
    • Verify that all references are correct and point to existing sections in the new documentation.
The PR consolidates documentation by moving various README files into a centralized `docs/` directory, updating references, and removing outdated files. This change appears safe to merge, but ensure that all necessary information is retained in the new documentation structure. ## Walkthrough - **Documentation Consolidation** - Moved various README files into a centralized `docs/` directory. - Updated references in code and documentation to point to the new locations. - Removed outdated README files from individual crates and deployment directories. - Ensure that all necessary information from the removed files is retained in the new documentation structure. - **CI Configuration** - Updated `.forgejo/workflows/ci.yml` to reference the new documentation paths. - Verify that all references are correct and point to existing sections in the new documentation.
Merge branch 'main' into docs/quickstart-cleanup
All checks were successful
CI / Verify PR with nix flake check (pull_request) Successful in 4m59s
Details
CI / Request auto_review semantic review (pull_request) Successful in 1s
Details
auto_review auto_review: no findings
CI / Build PR artifacts (no token) (pull_request) Successful in 1m9s
Details
CI / Publish PR artifact packages (pull_request) Successful in 53s
Details
Clean PR packages / Delete packages for merged PRs (pull_request) Successful in 15s
Details
9dc5d87feb
auto-review approved these changes 2026-05-08 22:15:42 -07:00
auto-review left a comment
Copy link

This PR consolidates the operator documentation by reorganizing and updating various documentation files, and updates the project version to 0.8.3. The changes appear safe to merge.

Walkthrough

Δ since 68ac6e9:

  • CHANGELOG.md:
    • Added a new entry for version 0.8.3, detailing fixes and other changes.
  • Cargo.lock & Cargo.toml:
    • Updated package versions to 0.8.3 across multiple crates, reflecting the new release.
This PR consolidates the operator documentation by reorganizing and updating various documentation files, and updates the project version to 0.8.3. The changes appear safe to merge. ## Walkthrough ### Δ since 68ac6e9: - **CHANGELOG.md**: - Added a new entry for version 0.8.3, detailing fixes and other changes. - **Cargo.lock & Cargo.toml**: - Updated package versions to 0.8.3 across multiple crates, reflecting the new release.
jwilger deleted branch docs/quickstart-cleanup 2026-05-08 22:23:11 -07:00
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
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!172
No description provided.