Merge pull request #68 from brainstormforce/claude-docs-setup

Author: kiransbsf

.claude/settings.json

@@ -0,0 +1,28 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx grunt:*)",
+      "Bash(npm install)",
+      "Bash(composer install)",
+      "Bash(./vendor/bin/phpcs:*)",
+      "Bash(git status)",
+      "Bash(git diff:*)",
+      "Bash(git log:*)",
+      "Bash(git branch:*)",
+      "Bash(git checkout:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(git remote:*)",
+      "Bash(ls:*)",
+      "Bash(find:*)",
+      "Bash(cat:*)",
+      "Bash(wc:*)"
+    ],
+    "deny": [
+      "Bash(rm -rf:*)",
+      "Bash(git push --force:*)",
+      "Bash(git reset --hard:*)"
+    ]
+  }
+}

.distignore

@@ -32,3 +32,7 @@ node_modules
 package-lock.json
 .github
 .wordpress-org
+
+.claude
+CLAUDE.md
+internal-docs

.gitignore

@@ -1,36 +1,38 @@
-# ignore PHPStorm extra directories
-.idea/
-
-# Leave node_modules from git
-node_modules/
-
-# sass cache
-.sass-cache
-
-# map files
-*.map
-
-# Skip package file from versoning
-*.zip
-*.sql
-*.tar.gz
-
-# ignore git inside subproject
-admin/bsf-core/.git
-
-# ignore PHPCS report files
-phpcs-summary.log
-phpcs-full.log
-
-# Exclude OS specific files
-.DS_Store
-
-# Exclude composer's directories
-vendor/
-
-# Exclude exported settings
-borders-for-default-menu.json
-defaults.json
-no-toggle-border-fix.json
-cghooks.lock
-wp-cli.local.yml
+# ignore PHPStorm extra directories
+.idea/
+
+# Leave node_modules from git
+node_modules/
+
+# sass cache
+.sass-cache
+
+# map files
+*.map
+
+# Skip package file from versoning
+*.zip
+*.sql
+*.tar.gz
+
+# ignore git inside subproject
+admin/bsf-core/.git
+
+# ignore PHPCS report files
+phpcs-summary.log
+phpcs-full.log
+
+# Exclude OS specific files
+.DS_Store
+
+# Exclude composer's directories
+vendor/
+
+# Exclude exported settings
+borders-for-default-menu.json
+defaults.json
+no-toggle-border-fix.json
+cghooks.lock
+wp-cli.local.yml
+.claude/settings.local.json
+config.bat

CLAUDE.md

@@ -0,0 +1,55 @@
+# Sidebar Manager
+
+## Project Overview
+
+Sidebar Manager is a WordPress plugin by Brainstorm Force. Create and manage custom sidebars with target rules.
+
+- **Version:** 2.0.0
+- **Text Domain:** bsfsidebars
+- **Main File:** sidebar-manager.php
+- **Requires:** WordPress, PHP 5.6+
+
+## Tech Stack
+
+- **Language:** PHP
+- **Platform:** WordPress
+- **Build:** Grunt (i18n, readme conversion)
+- **Coding Standards:** PHPCS with WordPress standards
+
+## Commands
+
+```bash
+# Install dependencies
+npm install
+composer install
+
+# Build (i18n + readme)
+npx grunt
+
+# Generate translations
+npx grunt i18n
+
+# Convert readme.txt to README.md
+npx grunt readme
+
+# Run PHPCS
+./vendor/bin/phpcs .
+```
+
+## Architecture
+
+This is a WordPress plugin following standard WordPress patterns:
+- Entry point: `sidebar-manager.php`
+- Constants defined for version, file path, base, dir, and URI
+- Classes loaded via `after_setup_theme` or `plugins_loaded` hook
+- Follows WordPress Coding Standards (WPCS)
+
+## Conventions
+
+- Use WordPress hooks (`add_action`, `add_filter`) for extensibility
+- Prefix all functions and classes to avoid conflicts
+- Use `bsfsidebars` text domain for all translatable strings
+- Escape all output (`esc_html`, `esc_attr`, `esc_url`, `wp_kses`)
+- Sanitize all input (`sanitize_text_field`, `absint`, etc.)
+- Use nonces for form submissions and AJAX requests
+- Follow WordPress PHP coding standards