docs(readme): modernize + add workflow status badges#163
Conversation
The README hadn't been touched to reflect several years of demo_farm work. Rewritten to match current reality: Workflow badges added at top: - ShellCheck (post-cleanup: rc has zero disable= lines) - build-tests (dry-run) -- per-PR fixture suite from openemr#147 - build-tests (live integration) -- nightly + per-PR matrix from openemr#148 - Derive ip_map (reconcile) -- auto-derive bot from openemr#135 ip_map_branch.txt column docs: - Converted from bullet list to table for readability. - Marked `branch_tag` (col 13) as deprecated -- matches the header annotation, the demo_build.sh comment ("col 13 (branch_tag) is deprecated; ... `git clone --branch` works for both"), and the fact that every production row now carries `0` there. - `fun_stuff`: documented actual code behavior. `1` = 36-theme picker, `2` = 6-theme picker, any other non-zero value falls through to the 36-theme picker via the `else` branch. Previously the README said "1 for <6.0, 2 for 6.0+" which reads like a version gate but is really a picker-selection. - `pass_reset`: documented that set_pass.php actually supports modes 1-4 (3/4 are 6.0.0+ variants), production uses 4, AND the mechanism is currently disabled pending openemr/openemr#5991. Column values are kept aligned with intended re-enable. - `capsule`: added the path-traversal guard mention (added in openemr#145) as a footnote-style note. New sections: - "Regression tests" -- describes the dry-run + live-integration suites from openemr#147/openemr#148 and the auto-derive fixtures. - "Auto-derive bot" -- describes the daily reconcile flow from openemr#135 including the release-targets-changed cross-repo dispatch. - "ShellCheck" -- notes the ratchet cleanup completion (PRs openemr#149 through openemr#157) and the current-clean state. Kept intact: - "UP FOR GRABS" onboarding steps (5-step process; still current). - "How to restart the demo farm after a host reboot" section (order + scripts still current). Trimmed the "watch this YouTube video 15 times" line since it dated the page. Intro paragraph rewritten to name the actual URL structure (demo.openemr.io etc.) and describe what a cluster/subdemo is, rather than the previous single-line description. License section preserved. Assisted-by: Claude Code
|
Warning Review limit reached
Next review available in: 52 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. ✨ 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 |
Summary
Rewrite of the README to reflect current demo_farm reality — several years' worth of work (auto-derive bot, build-tests suite, ShellCheck ratchet cleanup) had never made it into the README.
What's new
Workflow badges at the top (per your request):
disable=lines)Column docs corrected (previous docs had drift from current code):
branch_tag(not used)annotation +demo_build.shcomment + production data (all0).fun_stuff1= 36-theme picker,2= 6-theme picker, any other non-zero value falls through to the 36-theme picker. Previous phrasing ("1 for <6.0, 2 for 6.0+") read like a version gate.pass_resetset_pass.phpactually supports modes 1-4 (3/4 are 6.0.0+ variants), production uses4, AND that the mechanism is currently disabled pending openemr/openemr#5991. Previous docs still described modes 1/2 as if they were the whole set.capsuleFormat changed from bullet list to table for readability.
New sections:
Kept from previous README:
Intro paragraph rewritten to name the actual URL structure (demo.openemr.io etc.) and describe what a cluster/subdemo is, instead of the previous single-line description.
Notes
demo_build.sh,ip_map_branch.txtheader,set_pass.php, and workflow files. Anywhere the previous README disagreed with the code, I went with the code.🤖 Generated with Claude Code