Skip to content

chore(readme): update readme with workflow badges and removed some th…#3

Merged
breader1 merged 3 commits into
mainfrom
feature/linter-badge-readme
Feb 8, 2026
Merged

chore(readme): update readme with workflow badges and removed some th…#3
breader1 merged 3 commits into
mainfrom
feature/linter-badge-readme

Conversation

@breader1

@breader1 breader1 commented Feb 8, 2026

Copy link
Copy Markdown
Owner

…e examples we won't be using

Summary by CodeRabbit

  • Documentation
    • Added prominent header with project title, reference link, and three badges; preserved install/dev commands.
    • Removed outdated Building for Production, T3Env, and Data Fetching sections; updated Demo and Learn More headings and tightened overall formatting.
  • Tests
    • Updated test instructions to use npm test and noted that the Super-linter workflow runs on PRs.

@vercel

vercel Bot commented Feb 8, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
moodzic2-0 Ready Ready Preview, Comment Feb 8, 2026 2:26am

@coderabbitai

coderabbitai Bot commented Feb 8, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation-only updates to README.md: replaced project title, added Jira/Notion link and three badges, adjusted headings and spacing, reworded Getting Started and Testing sections, removed "Build for Production", "T3Env", and "Data Fetching" sections, and noted Super-linter runs on PRs. No code changes.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Replaced project title; added Notion/Jira link and three badges; promoted and reworded Getting Started; updated Testing to npm test; removed "Build for Production", "T3Env", and "Data Fetching" sections; noted Super-linter runs on PRs; adjusted headings/spacing and renamed demo/learn-more headings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Badges bloom and headings dance,

Links hop in — a tidy glance,
Tests renamed, old sections fall,
No code changed, just docs for all,
I nibble notes and take my chance.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: updating the README with workflow badges and removing unused sections, matching the changeset's primary modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/linter-badge-readme

No actionable comments were generated in the recent review. 🎉


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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Line 1: The Markdown link text currently reads "Jira" but points to a Notion
URL; update the link label to accurately reflect the destination by changing the
link text from "Jira" to "Notion" (or "Planning Doc") in the README line that
contains the Markdown link, e.g., replace the visible text "Jira" in the link
`[Jira](https://www.notion.so/...)` with "Notion" so the link label matches the
Notion URL.
🧹 Nitpick comments (1)
README.md (1)

38-38: Tighten the wording for clarity.

Consider a small grammar tweak to read more naturally.

✏️ Suggested wording
-Super-linter workflow is used to verify linting is done on each PR.
+The Super-linter workflow verifies linting on each PR.

Comment thread README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Line 3: The README's “Link to "Jira" Board” heading currently uses an h3 (###)
after the h1; update that heading to h2 (##) to fix the heading hierarchy and
satisfy MD001 linting; locate the heading that matches the text 'Link to "Jira"
Board' and replace the leading '###' with '##'.

Comment thread README.md Outdated
@breader1 breader1 merged commit febb0e8 into main Feb 8, 2026
4 checks passed
@breader1 breader1 deleted the feature/linter-badge-readme branch February 8, 2026 02:36
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