Inkweave Submodule Integration
Relevant source files
The following files were used as context for generating this wiki page:
The Inkweave Submodule Integration establishes a connection between the private administrative repository and the public Inkweave application code. This integration allows the admin tools to interact with the core application logic while maintaining a distinct environment for administrative functions.
The system pins the public repository as a dependency within the upstream/inkweave directory. This structure enables the administration project to deploy separate tools that share the base application's codebase.
Sources: README.md:3-4
Repository Architecture
The inkweave-admin repository acts as a wrapper for the core Inkweave application. It utilizes Git submodules to pull the public application code into a specific subdirectory for local development and deployment.
The diagram shows the hierarchical relationship between the admin repository and the public submodule.
Sources: README.md:3-4, upstream/inkweave
Submodule Configuration
The project defines the submodule relationship in the .gitmodules file. This configuration ensures that every developer and CI/CD environment uses the correct version of the public application.
| Parameter | Value | Description |
|---|---|---|
| Path | upstream/inkweave | The local directory where the public code resides. |
| URL | `https://github.com/Doberjohn/inkweave%60 | The remote source for the public application. |
| Visibility | Public | The source repository is publicly accessible. |
Sources: README.md:3-4, .gitmodules
Deployment Flow and Security
The administrative project deploys to a Vercel project. To maintain security, the deployment process includes a mandatory Vercel login requirement. This ensures that only authorized personnel access the admin tools.
The sequence diagram illustrates the path from code push to an authenticated deployment.
Sources: README.md:4
Administrative Standards and Planning
The integration follows specific guidelines defined in local documentation files. These files govern development behavior and track the progress of the integration phases.
- Operational Rules: The
CLAUDE.mdfile defines the working rules for the project environment. - Phase Tracking: The
docs/PLAN.mdfile records the design, planning, and status of various integration phases.
Sources: README.md:6, docs/PLAN.md, CLAUDE.md
Key Integration Components
| Component | File Path | Purpose |
|---|---|---|
| Core Application | upstream/inkweave | Provides the base public app logic. |
| Design Plan | docs/PLAN.md | Documents architectural phases and status. |
| Working Rules | CLAUDE.md | Establishes environment-specific guidelines. |
| Admin Logic | / | Contains private administrative tools and configurations. |
Sources: README.md:3-6, upstream/inkweave, docs/PLAN.md, CLAUDE.md
This integration ensures that administrative features remain isolated from the public codebase while staying synchronized with the latest application updates via the submodule pinning mechanism.