Adds ClaudeLog badge and Claude Code Resources section#379
Adds ClaudeLog badge and Claude Code Resources section#379ryoppippi merged 7 commits intoryoppippi:mainfrom wkasekende:main
Conversation
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughThe README.md file was updated to add a new badge for "ClaudeLog" in the header and introduce a "Claude Code Resources" section at the end. These additions provide informational references and visual enhancements without altering or removing any existing content. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @wkasekende, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the README.md by integrating new external resources pertinent to Claude AI development. The primary goal is to improve the discoverability and accessibility of a comprehensive knowledge base for advanced Claude mechanics and best practices, providing valuable context and learning materials directly within the project's main documentation.
Highlights
- New Badge Added: I've added a new 'ClaudeLog' badge to the top section of the
README.mdfile. This badge links directly toclaudelog.comand includes descriptive alt text summarizing the comprehensive knowledge base it represents, covering advanced Claude mechanics and best practices. - New Resource Section: I've introduced a dedicated 'Claude Code Resources' section in
README.md. This new section provides a detailed overview ofClaudeLog, crediting its creator, and includes multiple direct links to specific topics within the knowledge base, such as 'CLAUDE.md best practices', 'plan mode', 'ultrathink', and 'agent-first design'.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds a badge and a resource section for ClaudeLog to the README.md file. The new content is a valuable addition. I have provided a couple of suggestions to improve the accessibility and readability of the new content.
README.md
Outdated
| [`ClaudeLog`](https://claudelog.com) by [InventorBlack](https://www.reddit.com/user/inventor_black/) | ||
| A comprehensive knowledge base with detailed breakdowns of advanced [mechanics](https://claudelog.com/mechanics/you-are-the-main-thread/) including [CLAUDE.md best practices](https://claudelog.com/mechanics/claude-md-supremacy), practical technique guides like [plan mode](https://claudelog.com/mechanics/plan-mode), [ultrathink](https://claudelog.com/faqs/what-is-ultrathink/), [sub-agents](https://claudelog.com/mechanics/task-agent-tools/), [agent-first design](https://claudelog.com/mechanics/agent-first-design/), [agent engineering](https://claudelog.com/mechanics/agent-engineering/), [humanising agents](https://claudelog.com/mechanics/humanising-agents/) and [configuration guides](https://claudelog.com/configuration). |
There was a problem hiding this comment.
I have a couple of suggestions to improve the formatting and readability of this new section:
- Trailing Whitespace: Line 119 has trailing whitespace that should be removed to maintain code cleanliness.
- Readability: The description on line 120 is quite dense with many inline links. Restructuring it as a bulleted list would make it much easier for readers to scan and digest.
Here's a suggested implementation that addresses both points:
[`ClaudeLog`](https://claudelog.com) by [InventorBlack](https://www.reddit.com/user/inventor_black/)
A comprehensive knowledge base with detailed breakdowns of advanced topics, including:
* Advanced [mechanics](https://claudelog.com/mechanics/you-are-the-main-thread/) and [CLAUDE.md best practices](https://claudelog.com/mechanics/claude-md-supremacy).
* Practical technique guides for [plan mode](https://claudelog.com/mechanics/plan-mode), [ultrathink](https://claudelog.com/faqs/what-is-ultrathink/), and [sub-agents](https://claudelog.com/mechanics/task-agent-tools/).
* Concepts like [agent-first design](https://claudelog.com/mechanics/agent-first-design/), [agent engineering](https://claudelog.com/mechanics/agent-engineering/), and [humanising agents](https://claudelog.com/mechanics/humanising-agents/).
* [Configuration guides](https://claudelog.com/configuration).There was a problem hiding this comment.
Thank you for the instruction, @wkasekende. As gemini-code-assist, I am an AI assistant and cannot directly make changes to the pull request. My role is to provide feedback and suggestions.
I have already provided a suggested implementation in my previous comment (Message 1 of 2 in this thread) that addresses the trailing whitespace and improves readability by using a bulleted list. You can copy and paste that suggested code block into your README.md file to apply the changes.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
12-14: Trim the extremely longaltattribute on the new badge
The currentalttext is ~230 characters. Such length harms readability of raw Markdown, adds noise for screen-reader users, and exceeds most accessibility guidelines that recommend concise descriptions.- <a href="https://claudelog.com/"><img src="https://claudelog.com/img/claude_log_badge.svg" alt="A comprehensive knowledge base with detailed breakdowns of advanced mechanics including CLAUDE.md best practices, practical technique guides like plan mode, ultrathink, sub-agents, agent-first design and configuration guides." /></a> + <a href="https://claudelog.com/"><img src="https://claudelog.com/img/claude_log_badge.svg" alt="ClaudeLog knowledge base" /></a>
117-121: Consider breaking the long sentence into bullets for readability
Lines 119-121 list eight resources in one extended sentence. Splitting them into a bulleted list (or at least inserting line breaks) would improve scan-ability and keep the style consistent with other sections that use lists for feature descriptions.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
README.md (2)
Learnt from: CR
PR: ryoppippi/ccusage#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T10:58:04.397Z
Learning: Applies to docs/**/*.md : Always include descriptive alt text for screenshots in documentation for accessibility
Learnt from: CR
PR: ryoppippi/ccusage#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T10:58:04.397Z
Learning: Applies to docs/guide/{index,daily-reports,live-monitoring,mcp-server}.md : Guides with screenshots: /docs/guide/index.md, /docs/guide/daily-reports.md, /docs/guide/live-monitoring.md, /docs/guide/mcp-server.md
🪛 markdownlint-cli2 (0.17.2)
README.md
122-122: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
123-123: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
124-124: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
125-125: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (1)
README.md (1)
12-12: Badge addition looks good – concise, descriptivealttext.The new ClaudeLog badge integrates cleanly with the existing badge block, and the alt text is short yet informative, satisfying accessibility guidance from earlier feedback. No changes needed.
commit: |
|
sorry we are in the UK but spell check is for US English |
|
Ok, now I think we're good. @ryoppippi |
2 participants
Summary by CodeRabbit