Skip to content

docs: add verification index for scripts and local commands (WA-DOC-007)#858

Open
kitcommerce wants to merge 2 commits intonextfrom
kit/854-verification-index
Open

docs: add verification index for scripts and local commands (WA-DOC-007)#858
kitcommerce wants to merge 2 commits intonextfrom
kit/854-verification-index

Conversation

@kitcommerce
Copy link
Contributor

Summary

Adds docs/verification/verification-index.md — a short index that maps all available verification scripts and the most common local development commands to their deeper reference docs.

What's in it:

  • Table of available scripts (script/test, script/clean, scripts/run-benchmarks.sh) with a plain-English description of what each does
  • Exact invocation examples for script/test (component-level and file-level)
  • One-liner Docker startup command with required env vars (Mongo/Redis/Elasticsearch)
  • RuboCop diff-only snippet (vs origin/next)
  • Targeted engine test commands with an auto-detect snippet
  • Table of all docs in docs/verification/ with links and brief descriptions

Links to wa-ci-008-local-build-gate.md for the full pre-PR checklist rather than duplicating that content.

Changes

  • docs/verification/verification-index.md — new file (docs only, no code changes)

Client impact

None expected. Documentation-only change.

Fixes #854

@kitcommerce kitcommerce added gate:build-pending Build gate running gate:build-passed Build gate passed review:architecture-pending Review in progress review:simplicity-pending Review in progress review:security-pending Review in progress review:rails-conventions-pending Rails conventions review in progress review:architecture-done Review complete and removed gate:build-pending Build gate running review:architecture-pending Review in progress labels Mar 10, 2026
@kitcommerce
Copy link
Contributor Author

Architecture Review\n\n

@kitcommerce kitcommerce added review:security-done Review complete and removed review:security-pending Review in progress labels Mar 10, 2026
@kitcommerce
Copy link
Contributor Author

@-

@kitcommerce kitcommerce added review:simplicity-done Review complete and removed review:simplicity-pending Review in progress labels Mar 10, 2026
@kitcommerce
Copy link
Contributor Author

@-

@kitcommerce kitcommerce added review:rails-conventions-done Rails conventions review complete and removed review:rails-conventions-pending Rails conventions review in progress labels Mar 10, 2026
@kitcommerce
Copy link
Contributor Author

@-

Kit (OpenClaw) added 2 commits March 17, 2026 03:26
Adds docs/verification/verification-index.md — a short index that maps
available scripts (, ,
════════════════════════════════════════
  Workarea Test Suite Benchmark
════════════════════════════════════════
  Timestamp: 20260309-211643
  Logs: /Users/Shared/openclaw/projects/workarea-modernization/repos/workarea/tmp/benchmarks

════════════════════════════════════════
  Environment
════════════════════════════════════════
Ruby:          ruby 3.2.7 (2025-02-04 revision 02ec315244) [arm64-darwin25]
Bundler:       Bundler version 2.4.22
Rails:         6.1.7.10
Mongoid:       7.4.3
Elasticsearch:
Git branch:    kit/854-verification-index
Git commit:    caef7b4

Docker services:
workarea-elasticsearch-1: Up 10 hours
workarea-redis-1: Up 11 hours
workarea-mongo-1: Up 11 hours

════════════════════════════════════════
  Boot Time (3 runs)
════════════════════════════════════════
  Run 1: )
and the most common local development commands (Docker services, RuboCop
diff-only, targeted engine tests) to their deeper reference docs.

Links out to WA-CI-008 (wa-ci-008-local-build-gate.md) for the full
pre-PR checklist rather than duplicating that content.

Fixes #854
…dditional scripts

- Add script/docker_services_health entry with usage example
- Add script/default_appraisal_boot_smoke entry and usage example (step 4)
- Add script/system_prereqs, script/preflight, script/verify entries
- Add script/check_service_ports, script/elasticsearch_http_check entries
- Add script/docker_services_status/versions entries
- Add script/default_appraisal_deprecations, script/default_appraisal_zeitwerk_check entries
- Update Docker services section to use script/docker_services_health for verification
- Add wa-verify-031 and wa-verify-058 to the docs table
@kitcommerce kitcommerce force-pushed the kit/854-verification-index branch from db90502 to a003288 Compare March 17, 2026 07:26
@kitcommerce
Copy link
Contributor Author

Changes addressed

Rebased onto current origin/next and expanded the verification index:

Additions to docs/verification/verification-index.md

  • Added script/docker_services_health entry with usage example (links to the new health-check script from Add docker services health-check script #863)
  • Added script/default_appraisal_boot_smoke entry with usage example (Step 4 in common commands)
  • Added entries for script/system_prereqs, script/preflight, script/verify, script/check_service_ports, script/elasticsearch_http_check, script/docker_services_status, script/docker_services_versions, script/default_appraisal_deprecations, script/default_appraisal_zeitwerk_check
  • Updated the Docker services section to use script/docker_services_health for post-start verification
  • Expanded the docs table to include wa-verify-031 and wa-verify-058

This makes the index a complete reference to all available verification scripts in script/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gate:build-passed Build gate passed review:architecture-done Review complete review:rails-conventions-done Rails conventions review complete review:security-done Review complete review:simplicity-done Review complete

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant