READMEs: cleanup spelling, formatting; delete outdated docs#2712
READMEs: cleanup spelling, formatting; delete outdated docs#2712
Conversation
The deleted items were either out of date, or incorrect, or both.
WalkthroughThis pull request consolidates and refactors project documentation. It removes several deprecated documentation files including code style guidelines, workstation setup instructions, pull request workflow procedures, and director console debugging steps for versions 265.x and earlier. Docker Compose configuration for local database services and duplicate database schema documentation are also removed. The remaining documentation receives formatting improvements, including table alignment adjustments, typo corrections (such as "heatbeat" to "heartbeat" and "reciept" to "receipt"), and wording refinements. Documentation references are streamlined by removing links to hotfix and manual release workflows. 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/README.md`:
- Around line 17-21: Remove the dangling fragment "There have been" and replace
it with a complete sentence in the schema section (for example, merge it into or
replace with "Steps to generate the schema:"), and fix the hyphenation by
changing "Right click database connection" to "Right-click database connection"
so the lines containing "There have been", "Steps to generate:", and "Right
click database connection" are corrected and read smoothly.
In `@README.md`:
- Around line 3-4: Update the README intro wording: change “open source” to
“open-source” in the sentence starting with “Cloud Foundry BOSH is an open
source tool…”, and standardize the phrasing/capitalization on the repo list line
that currently references line 34 by ensuring it uses “repository” (lowercase r)
and “BOSH” (all-caps) consistently; apply these copy edits so the intro and the
repo list use “open-source”, “repository”, and “BOSH” with consistent
capitalization and style.
In `@src/bosh-monitor/lib/bosh/monitor/plugins/README.md`:
- Line 21: Fix the typos in the Consul options table in README.md: change the
term "protocal" to "protocol" and change "real time" to "real-time" (leave "as
events" as-is). Update the table cells containing those exact strings so both
occurrences are corrected.
In `@src/bosh-monitor/README.md`:
- Around line 129-130: Replace the hardcoded absolute URLs pointing to the repo
tree for the plugin authoring steps with branch-agnostic relative links: change
the link targets in the lines mentioning "Create a `plugin.rb` for your plugin
extension" and "Create a matching test file for your plugin extension `spec.rb`"
(and the same occurrences later) to use relative paths (e.g.,
./lib/bosh/monitor/plugins and ./spec/unit/bosh/monitor/plugins) instead of URLs
containing "master" so the docs remain valid across branches.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 5dc35b1d-e82d-417f-999c-4b4d67f89cb4
⛔ Files ignored due to path filters (2)
docs/director_schema/bosh-db-diagram.pngis excluded by!**/*.pngdocs/director_schema/bosh-db-diagram.svgis excluded by!**/*.svg
📒 Files selected for processing (11)
README.mddocs/README.mddocs/code_style.mddocs/director-console-debugging.mddocs/director_schema/README.mddocs/docker-compose.ymldocs/ip_reservation_flow.mddocs/pull_request_workflow.mddocs/workstation_setup.mdsrc/bosh-monitor/README.mdsrc/bosh-monitor/lib/bosh/monitor/plugins/README.md
💤 Files with no reviewable changes (6)
- docs/director_schema/README.md
- docs/director-console-debugging.md
- docs/pull_request_workflow.md
- docs/code_style.md
- docs/docker-compose.yml
- docs/workstation_setup.md
The deleted items were either out of date, or incorrect, or both.