Skip to content

docs: repo audit pass — commit spec, agent context cleanup, README polish#57

Merged
mmorerasanchez merged 3 commits into
mainfrom
fix/ai-overview-polish-v3.3
Jun 2, 2026
Merged

docs: repo audit pass — commit spec, agent context cleanup, README polish#57
mmorerasanchez merged 3 commits into
mainfrom
fix/ai-overview-polish-v3.3

Conversation

@mmorerasanchez

@mmorerasanchez mmorerasanchez commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Three-commit audit sweep to align public repo files with OSS best practices.

  • docs(contributing): full Conventional Commits spec with all 8 types, scopes, description rules, good/bad examples, and component PR checklist (10-item pre-merge verification)
  • docs(agents): removed private Notion workflow instructions from CLAUDE.md (internal tool refs don't belong in a public file); added commit format section to AGENTS.md for cross-tool completeness
  • docs(readme): removed ⚛️ emoji from h1, updated footer to professional format, fixed stale tailwind.config.ts references in README and DESIGN.md

No component or token changes. Documentation only.

Summary by CodeRabbit

Documentation

  • Added comprehensive commit convention guidelines for contributors
  • Introduced pre-PR checklist covering design, accessibility, testing, and submission requirements
  • Updated design token and theming documentation to clarify current implementation
  • Refined README with clearer description of the project's visual identity

@vercel

vercel Bot commented Jun 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
democrito Ready Ready Preview, Comment Jun 2, 2026 8:44am

@mmorerasanchez mmorerasanchez merged commit 0cde52e into main Jun 2, 2026
3 of 4 checks passed
@mmorerasanchez mmorerasanchez deleted the fix/ai-overview-polish-v3.3 branch June 2, 2026 08:44
@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7c1ae452-09e8-4611-90c4-06bdf88210a8

📥 Commits

Reviewing files that changed from the base of the PR and between 9d1f085 and f3f3781.

📒 Files selected for processing (5)
  • AGENTS.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • DESIGN.md
  • README.md

📝 Walkthrough

Walkthrough

This PR updates documentation across five files to establish unified commit conventions, consolidate Tailwind v4 design token guidance into src/index.css, define a contribution checklist, and apply minor branding updates to the README. All changes align the repository's documentation around Conventional Commits and the @theme block as the single source of truth for design tokens.

Changes

Documentation: Commit Conventions, Design Token Guidance, and Contribution Process

Layer / File(s) Summary
Commit convention standardization
AGENTS.md, CLAUDE.md, CONTRIBUTING.md
Adds Conventional Commits format with type/scope/description rules to AGENTS.md for AI context, replaces Notion sync workflow in CLAUDE.md with commit format requirement, and expands commit convention guidance in CONTRIBUTING.md with structured tables, description rules, and "Don't write / Write" examples.
Design token and Tailwind v4 guidance alignment
DESIGN.md, CONTRIBUTING.md, README.md
Updates token definition guidance in DESIGN.md and CONTRIBUTING.md to specify that CSS custom properties and @theme mappings are defined in src/index.css, and clarifies in README.md that both CSS custom properties and font definitions live in src/index.css's @theme block; removes all tailwind.config.ts references across files.
Contribution workflow and pre-PR checklist
CONTRIBUTING.md
Inserts a new "Pre-PR checklist" section covering placement, token usage constraints, typography, theming, responsiveness, accessibility, exports, showcase, tests, and docs; updates "Submit a pull request" instructions to require title, description, and screenshots demonstrating all three themes.
README branding and title updates
README.md
Simplifies the main heading from "⚛️ democrito" to "democrito", and replaces the footer text with "Made in Spain", "MIT License", and maintenance credit.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • mmorerasanchez/democrito#52: Extends AGENTS.md with AI-agent context by adding the Commit Convention section directly included in this PR.
  • mmorerasanchez/democrito#18: Updates documentation to consolidate design token guidance to src/index.css and remove tailwind.config.ts references, mirroring the token location changes in this PR.
  • mmorerasanchez/democrito#11: Shifts the source of truth for theme and design tokens to src/index.css's @theme block, aligning with the Tailwind v4 guidance updates across multiple files in this PR.

Poem

🐰 With whiskers twitching, we hop through docs today,
Commit conventions written in the clearest way,
Design tokens gather where the @theme block glows,
Pre-PR checklists guide each step we chose,
A documented garden where good practices grow! 🌿

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/ai-overview-polish-v3.3

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.

❤️ Share

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

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