Submodule Synchronization Strategy
Relevant source files
The following files were used as context for generating this wiki page:
The inkweave-admin repository maintains a private suite of administrative tools for the Inkweave platform. It employs a submodule strategy to incorporate the public application's core logic while maintaining a distinct, secure environment for administrative operations.
This strategy ensures that the admin tools stay aligned with the latest features of the public application while allowing for a private deployment workflow on Vercel.
Sources: README.md:3-5
Repository Architecture
The architecture relies on a parent-child relationship between the private admin repository and the public core repository. The admin repository "pins" a specific version of the public repository to ensure stability and compatibility.
Submodule Configuration
The public application code resides in the upstream/inkweave directory. This path is defined as a Git submodule, allowing the admin project to reference the Doberjohn/inkweave repository as a dependency.
The diagram shows the relationship between the public repository and its integration as a submodule within the admin repository's directory structure.
Sources: README.md:3-4, .gitmodules
Deployment and Security
The synchronization strategy extends to the deployment pipeline. The inkweave-admin project deploys to a specific Vercel project. To maintain the privacy of the administrative tools, the deployment is restricted behind a Vercel login.
Component Summary
| Component | Repository / Path | Access Level | Description |
|---|---|---|---|
| Public App | Doberjohn/inkweave | Public | Core platform logic and user interface. |
| Admin App | Doberjohn/inkweave-admin | Private | Administrative tools and management interfaces. |
| Submodule Path | upstream/inkweave | Internal | The location of the public core within the admin repo. |
| Deployment | Vercel | Authenticated | Restricted environment requiring Vercel credentials. |
Sources: README.md:3-5
Synchronization Workflow
Synchronizing the submodule involves updating the pointer in the admin repository to reflect the desired commit in the public repository. This process ensures that administrative tools utilize the correct version of the core logic.
The sequence diagram illustrates the flow of updates from the public repository through the admin repository to the final deployment.
Sources: README.md:3-5, CLAUDE.md
Operational Rules and Planning
Technical implementation details and development guidelines are distributed across specific documentation files. These files govern how synchronization and development are handled within the admin context.
- Design and Phases: The
docs/PLAN.mdfile tracks the status of development phases and architectural designs. - Working Rules: The
CLAUDE.mdfile defines the coding standards and operational rules for the environment.
Sources: README.md:7-8, docs/PLAN.md, CLAUDE.md
Summary
The submodule synchronization strategy in inkweave-admin provides a secure method for extending the public inkweave platform with private administrative capabilities. By pinning the public repository at upstream/inkweave, the project achieves a reliable balance between code reuse and environment isolation, backed by Vercel's authentication layer.
Sources: README.md:3-5