Skip to content

docs: standardize README to Open Paws ecosystem template#26

Merged
samtuckerdavis merged 1 commit into
mainfrom
readme-standardization
Apr 18, 2026
Merged

docs: standardize README to Open Paws ecosystem template#26
samtuckerdavis merged 1 commit into
mainfrom
readme-standardization

Conversation

@samtuckerdavis
Copy link
Copy Markdown

Summary

  • Rewrites README to the Open Paws ecosystem template: badge row, TL;DR, ecosystem note, visual, quickstart, features (scoring model + fork additions), docs table, architecture <details>, contributing, license/acknowledgments, footer
  • Preserves all real information from the existing README — no fabricated numbers, no hype language
  • Adds the Open Paws ecosystem callout block and standard footer (Donate, Discord, openpaws.ai, Volunteer)
  • Adds metadata comment block (tech_stack, project_status, difficulty, skill_tags, related_repos)
  • Replaces the flat "What Is / What This Fork Adds" structure with the standardized section order

What was kept

All content from the existing README is retained or reorganized: scoring model weights, language support count (29 languages), advocacy language rule table (65 rules across 5 categories), security detector adversary model, persona QA commands, Windows fixes, install instructions, command reference, upstream tracking, and contributing guidance.

What was omitted

The full command reference table (26 rows) was removed from the body — it lives in docs/SKILL.md which is linked in the docs table. This keeps the README focused on orientation rather than exhaustive reference.

Test plan

  • Review rendered README on the branch: https://github.com/Open-Paws/desloppify/blob/readme-standardization/README.md
  • Confirm badge row renders correctly (PyPI badge may show "unknown" until package is published to PyPI under this fork's name)
  • Confirm assets/explained.png renders in the visual section
  • Confirm the [!NOTE] callout renders as a GitHub admonition block
  • Confirm the <details> architecture section collapses correctly

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 18, 2026

Warning

Rate limit exceeded

@stuckvgn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 45 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 3 minutes and 45 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: dcca140a-0e37-404e-b5fa-cd2b2ae00af6

📥 Commits

Reviewing files that changed from the base of the PR and between 4aa174f and dbb0e53.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-standardization
  • 🛠️ fix NAV violations: Commit on current branch
  • 🛠️ fix NAV violations: Create PR

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

Auto-Merge Gate Check — Blocked

PR labeled needs-human-review — one or more gates failed.

Failed Gates

  • Classification label missing — PR needs wave0-auto or level-0 label
  • PR author 'stuckvgn' is not a known agent bot
  • CI checks not all green: Incomplete: tests-core, ci-contracts, tests-full, lint, package-smoke, arch-contracts, typecheck, check, Analyze (python), Analyze (javascript-typescript), Analyze (actions).

How to unblock

  • Fix the failing gates and push a new commit — this workflow re-runs automatically.
  • If CI is still running, wait for it to complete.
  • If NAV config is absent, open a task to install the no-animal-violence suite.

Permanent block

  • Add the human-gate label to permanently disable auto-merge for this PR.

Auto-Merge Gate Check — 2026-04-18T03:19:04.023Z

@samtuckerdavis
Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 18, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@samtuckerdavis samtuckerdavis merged commit f4365d0 into main Apr 18, 2026
15 checks passed
@samtuckerdavis samtuckerdavis deleted the readme-standardization branch April 22, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant