AI & Developer Rules (CLAUDE.md)
Relevant source files
The following files were used as context for generating this wiki page:
The CLAUDE.md file defines the operational guidelines, coding standards, and development workflows for the inkweave-admin repository. This project serves as a private administrative suite for the Inkweave application, providing tools that remain separate from the public-facing repository. The document ensures consistency for both human developers and AI assistants when modifying the admin tools or interacting with the core application logic pinned as a submodule.
Sources: README.md:1-7
Project Architecture and Integration
The inkweave-admin project functions as a wrapper around the core Inkweave application. It maintains a strict separation between administrative functionality and the public application logic.
Submodule Management
The project pins the public Inkweave repository as a Git submodule. This structure allows the admin tools to reference the main application's code while maintaining a private deployment environment.
- Path:
upstream/inkweave - Source Repository:
Doberjohn/inkweave
Sources: README.md:3-4, .gitmodules
Deployment Workflow
The application deploys to Vercel. Security is enforced through Vercel's native login system, ensuring that administrative tools are not accessible to the public.
The diagram above illustrates how the admin repository incorporates the upstream submodule and utilizes Vercel for secure hosting.
Sources: README.md:4-5
Development Guidelines
The CLAUDE.md file establishes the "Working Rules" for the repository. These rules govern how code is written, how submodules are updated, and how new features are planned.
Core Components
| Component | Purpose | Reference |
|---|---|---|
| CLAUDE.md | Working rules and AI instructions | CLAUDE.md |
| docs/PLAN.md | Design specifications and phase status | docs/PLAN.md |
| upstream/inkweave | Pinned public application code | .gitmodules |
Sources: README.md:6-7
Development Workflow
Developers must follow a structured approach to modification and planning:
- Plan: Consult
docs/PLAN.mdto check the status of current phases and design requirements. - Execute: Follow specific coding patterns defined in
CLAUDE.md. - Sync: Ensure the
upstream/inkweavesubmodule remains at the correct pinned version relative to the admin requirements.
Sources: README.md:6-7, docs/PLAN.md
Operational Commands
While specific script implementations reside in package.json, CLAUDE.md provides the context for their usage during development and testing.
The sequence diagram shows the typical initialization and validation flow for developers working on the admin suite.
Sources: README.md:3-5, package.json
Summary of Technical Standards
The repository emphasizes a documentation-first approach. All architectural decisions and status updates are tracked in docs/PLAN.md, while CLAUDE.md acts as the source of truth for immediate developer actions and style preferences. This ensures that the private admin tools remain synchronized with the public application developments without exposing sensitive administrative logic to the public repository.
Sources: README.md:1-7