Skip to content

docs(claude-md): structurally reorganize project guidance#18

Merged
saagpatel merged 1 commit into
polish/v1.0-improvementsfrom
docs/claude-md-audit-v3
May 18, 2026
Merged

docs(claude-md): structurally reorganize project guidance#18
saagpatel merged 1 commit into
polish/v1.0-improvementsfrom
docs/claude-md-audit-v3

Conversation

@saagpatel
Copy link
Copy Markdown
Owner

Re-opens the work from closed PRs #15 and #17 on the correct base branch (polish/v1.0-improvements). Content is identical to commit 8c45543; only the lineage differs.

Manually merged: operator's authoritative edits (npm/pnpm framing from 1c212a1, parent-scope drop from 2ab34ca, portfolio-context dedup from 7cf00a2) as base, with structural improvements from a prior Sonnet rewrite layered on top.

Kept from polish (operator's authoritative edits):

  • pnpm-not-npm framing as a primary "Do NOT" rule
  • Parent-scope note correctly absent
  • Auto-managed portfolio-context block removed; key facts distilled into Key Decisions table

Layered in from agent rewrite:

  • 8-section flat structure (Overview, Tech Stack by layer, Local Dev, Test Commands per layer, Build, Architecture, Project Structure, Conventions, Current Phase, Key Decisions, Do NOT)
  • Per-layer test command blocks with CI status annotations (CI GREEN / CI STATUS: CHECK FIRST)
  • Concrete paths: src-tauri/target/, dist/, ~/Library/Application Support/com.jcc.app/jcc.db, ~/.jcc/gmail/
  • Version pins: Tauri 2.x, tauri-specta 2.0.0-rc.21, Playwright 1.52+, anthropic>=0.52
  • Expanded Do NOT list (13 items)

Flag: The <!-- portfolio-context:start/end --> managed block was removed. When the personal-ops portfolio-context generator next syncs, it'll re-inject — and the "npm only" line will be wrong again. The Do NOT section's pnpm override now precedes the managed block as a hard rule, so agents won't be misled. Patching the generator is out of scope.

Authored by 2x Sonnet 4.6 agents under Opus 4.7 coordination (Tier 2 pattern).

Manually merged: operator's authoritative edits (npm/pnpm framing from
1c212a1, parent-scope drop from 2ab34ca, portfolio-context dedup from
7cf00a2) as base, with structural improvements layered on top.

- 8-section flat structure (Overview, Tech Stack by layer, Local Dev,
  Test Commands per layer with CI status, Build, Architecture, Project
  Structure, Conventions, Current Phase, Key Decisions, Do NOT)
- Per-layer test command blocks with CI status annotations
- Concrete paths: src-tauri/target/, dist/, ~/Library/Application Support/
  com.jcc.app/jcc.db, ~/.jcc/gmail/
- Version pins: Tauri 2.x, tauri-specta 2.0.0-rc.21, Playwright 1.52+,
  anthropic>=0.52
- Expanded Do NOT list (13 items)

Authored by 2x Sonnet 4.6 agents under Opus 4.7 coordination; the final
file content is identical to the prior closed PR #17 / commit 8c45543 —
this re-opens it on the correct base (polish/v1.0-improvements).
@saagpatel saagpatel merged commit 7586b4f into polish/v1.0-improvements May 18, 2026
2 checks passed
@saagpatel saagpatel deleted the docs/claude-md-audit-v3 branch May 18, 2026 09:37
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6aa7cdcaf5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread CLAUDE.md
- **Framework:** React 19 + TypeScript (strict) + Vite
- **UI:** shadcn/ui + Tailwind CSS
- **State:** `useState` (component) → Zustand 5 (global UI) → TanStack Query 5 (SQLite/persistent data)
- **Package manager:** **pnpm** (pnpm v10 per CI; `pnpm-lock.yaml` is canonical — ignore `package-lock.json` which is an orphan from the initial template scaffold)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore npm as the documented package manager

This switches the guidance to pnpm and tells agents to ignore package-lock.json, but the repo’s public setup docs still install/run with npm (README.md lines 36 and 43-46) and the release workflow caches npm and runs npm ci (.github/workflows/release.yml lines 40 and 57). When future dependency or script changes follow this file, they can update only pnpm-lock.yaml or run the wrong install path, leaving package-lock.json stale and breaking the release build that depends on it.

Useful? React with 👍 / 👎.

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