Skip to content

docs: update AGENTS.md and CLAUDE.md with accurate project info - #20

Merged
nazozokc merged 1 commit into
mainfrom
AI-agent
Jun 21, 2026
Merged

docs: update AGENTS.md and CLAUDE.md with accurate project info#20
nazozokc merged 1 commit into
mainfrom
AI-agent

Conversation

@nazozokc

@nazozokc nazozokc commented Jun 21, 2026

Copy link
Copy Markdown
Owner

Summary

Updated the repository's agent instruction files (AGENTS.md → CLAUDE.md symlinks) to reflect the actual codebase state.

Changes

Root CLAUDE.md (AGENTS.md)

  • Added frontmatter (description metadata)
  • Added Agent Role section — defines what the agent does in this repo
  • Added Design Tenets — 5 guiding principles (CLI-native, SQLite, layer separation, interactive+scriptable, portable)
  • Added Architecture Overview — expanded from 4 layers to 8 source files
  • Added Available Skills table — when to load each repo skill
  • Added complete command reference (13 commands)
  • Organized Key Conventions with corrections (gunshi not commander)

subtrack/CLAUDE.md (subtrack/AGENTS.md)

  • Fixed CLI framework: commandergunshi
  • Added Node.js >=22 requirement
  • Added picocolors to tech stack
  • Expanded architecture table: 5 files → 13 files (all source files)
  • Completed command list: 7 → 13 commands
  • Fixed delete signature (accepts positional IDs)

Related

  • The 3 repo skills (subtrack-rules, subtrack-commit, bug-fixes) remain unchanged under .agents/skills/

Summary by CodeRabbit

  • Documentation
    • Restructured and expanded development documentation with updated architecture guidance and configuration references.
    • Updated technology stack specifications for project setup.
    • Expanded CLI command documentation with additional subcommand details.
    • Added environment configuration reference section.

- Add frontmatter, agent role, design tenets to root AGENTS.md/CLAUDE.md

- Add available skills reference and architecture overview

- Fix CLI framework: commander → gunshi

- Add complete command list (13 commands)

- Expand architecture table to cover all source files

- Add picocolors to tech stack

- Fix delete command signature
@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Both CLAUDE.md (root) and subtrack/CLAUDE.md are rewritten as structured documentation. The root file becomes an agent instruction document with role, design tenets, architecture overview, skills catalog, conventions, and CLI reference. The subtrack file updates the tech stack, architecture table, DB conventions, and commands table.

Changes

CLAUDE.md Documentation Rewrites

Layer / File(s) Summary
Root CLAUDE.md agent instructions and reference
CLAUDE.md
Rewrites the file as an agent instruction document: adds agent role/responsibilities, .agents/skills/ directory entry, design tenets, architecture-to-subtrack/src/* module mapping, available skills section, updated key conventions (runtime, DB, CLI, import style, price storage), expanded quick-reference commands, fuller CLI commands table, and a populated SUBSC_CLI_DB_DIR environment variable entry.
subtrack/CLAUDE.md tech stack, architecture, and commands
subtrack/CLAUDE.md
Updates Node.js version to >=22 and changes CLI library from commander to gunshi; replaces the 4-layer architecture table with a file-level module responsibility mapping; removes the Cycles convention and adds a sql.js foreign key (PRAGMA foreign_keys = ON) and transaction convention; expands the commands table with edit, delete [ids...], tag subcommands, multi-format export, import <file>, summary, backup/restore, and payment/usage variants.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • nazozokc/subtrack#12: Previously rewrote subtrack/CLAUDE.md with overlapping changes to the tech stack, architecture, DB conventions, and command table sections.

Poem

🐇 Hoppity-hop through the docs I go,
Swapping out commander for gunshi's flow,
Foreign keys pragma, transactions tight,
Agent instructions shining bright!
Every module mapped, every skill in view—
This rabbit keeps the CLAUDE.md true! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: update AGENTS.md and CLAUDE.md with accurate project info' directly and clearly matches the main changeset, which extensively revises these two documentation files to reflect the current codebase state.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch AI-agent

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
CLAUDE.md (1)

21-21: 💤 Low value

Add language identifier to fenced code block.

Line 21 shows a fenced code block without a language tag. Markdown linting (MD040) requires all code blocks to specify a language for syntax highlighting.

Fix for MD040
-```
+```bash
 pnpm install          # install all workspace dependencies
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CLAUDE.md` at line 21, Add a language identifier to the fenced code block in
CLAUDE.md that contains the pnpm install command. The code block currently
starts with triple backticks without a language tag; add the bash language
identifier (bash) immediately after the opening backticks to satisfy the MD040
linting rule which requires all code blocks to specify their language for proper
syntax highlighting.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@CLAUDE.md`:
- Line 21: Add a language identifier to the fenced code block in CLAUDE.md that
contains the pnpm install command. The code block currently starts with triple
backticks without a language tag; add the bash language identifier (bash)
immediately after the opening backticks to satisfy the MD040 linting rule which
requires all code blocks to specify their language for proper syntax
highlighting.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bddd8875-d1f4-4add-90f1-9c2c05b7d123

📥 Commits

Reviewing files that changed from the base of the PR and between b906bb2 and 108e25b.

📒 Files selected for processing (2)
  • CLAUDE.md
  • subtrack/CLAUDE.md

@nazozokc
nazozokc merged commit 0b86279 into main Jun 21, 2026
10 checks passed
@nazozokc
nazozokc deleted the AI-agent branch June 21, 2026 08: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