Skip to content

Add CLAUDE.md with project instructions - #8

Open
vedanshujain wants to merge 3 commits into
mainfrom
chore/add-claude-md
Open

Add CLAUDE.md with project instructions#8
vedanshujain wants to merge 3 commits into
mainfrom
chore/add-claude-md

Conversation

@vedanshujain

Copy link
Copy Markdown
Contributor

Summary

  • Adds CLAUDE.md documenting the project structure, build & deploy workflow, and workspace deployment process
  • Documents SSH as the preferred deployment method over MCP tools
  • Covers theme structure, SYNC convention, and WooCommerce Store API usage

Test plan

  • Verify CLAUDE.md is picked up by Claude Code in new sessions
  • Confirm SSH connection instructions are accurate

🤖 Generated with Claude Code

vedanshujain and others added 2 commits June 5, 2026 16:47
Documents build & deploy workflow, theme structure, SYNC convention,
and workspace deployment process for Claude Code sessions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request introduces CLAUDE.md, which provides instructions for Claude Code, covering the project overview, build and deployment steps, theme structure, sync conventions, and workspace deployment. The review feedback suggests renaming the "Theme structure" section to "Project structure" and nesting the theme-specific directories under themes/demo-store-headless/ to accurately reflect the repository layout, especially since mu-plugins/ is located at the repository root.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread CLAUDE.md
Comment on lines +26 to +36
## Theme structure

- `src/` — React source (JSX, CSS modules)
- `src/pages/` — route-level components (Home, Shop, ProductDetail, Cart, Checkout, OrderConfirmation)
- `src/components/` — shared components (Header, Footer, ProductList, ProductCard, PriceSlider)
- `src/api/` — WooCommerce Store API clients (storeApi, products, cart, checkout)
- `src/styles/` — CSS files including design tokens (`tokens.css`)
- `src/data/` — demo product fixtures for offline/demo mode
- `dist/` — Vite production build output (committed)
- `inc/` — PHP server-side rendering helpers (SSR router, SEO data, schema)
- `mu-plugins/` — WP-CLI seed scripts for demo data

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The section is titled "Theme structure", but it includes mu-plugins/ which is typically located at the repository root (or under wp-content/mu-plugins/) rather than inside the theme directory (themes/demo-store-headless/). Renaming this to "Project structure" and nesting the theme-specific directories under themes/demo-store-headless/ clarifies the actual layout of the repository.

Suggested change
## Theme structure
- `src/` — React source (JSX, CSS modules)
- `src/pages/` — route-level components (Home, Shop, ProductDetail, Cart, Checkout, OrderConfirmation)
- `src/components/` — shared components (Header, Footer, ProductList, ProductCard, PriceSlider)
- `src/api/` — WooCommerce Store API clients (storeApi, products, cart, checkout)
- `src/styles/` — CSS files including design tokens (`tokens.css`)
- `src/data/` — demo product fixtures for offline/demo mode
- `dist/` — Vite production build output (committed)
- `inc/` — PHP server-side rendering helpers (SSR router, SEO data, schema)
- `mu-plugins/` — WP-CLI seed scripts for demo data
## Project structure
- `themes/demo-store-headless/` — Headless theme directory
- `src/` — React source (JSX, CSS modules)
- `src/pages/` — route-level components (Home, Shop, ProductDetail, Cart, Checkout, OrderConfirmation)
- `src/components/` — shared components (Header, Footer, ProductList, ProductCard, PriceSlider)
- `src/api/` — WooCommerce Store API clients (storeApi, products, cart, checkout)
- `src/styles/` — CSS files including design tokens (`tokens.css`)
- `src/data/` — demo product fixtures for offline/demo mode
- `dist/` — Vite production build output (committed)
- `inc/` — PHP server-side rendering helpers (SSR router, SEO data, schema)
- `mu-plugins/` — WP-CLI seed scripts for demo data (located at the repository root)

Adds SCP example with absolute paths (required for SCP) and corrects
the SSH home/theme path details based on real workspace testing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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