Theming & Customization
Relevant source files
The following files were used as context for generating this wiki page:
The Inkweave-admin project provides a specialized administrative interface for the core Inkweave application. Theming and customization in this repository focus on extending the primary application via submodules and configuring deployment-specific settings for administrative use.
This repository serves as a wrapper that pins the public Inkweave application to specific versions while applying administrative-only features and security layers.
Sources: README.md:1-5
Architecture and Core Structure
The project uses a submodule architecture to maintain a link with the primary application. Customization occurs by wrapping the core logic within administrative tools and deploying it as a separate project.
Submodule Integration
The repository pins the public Doberjohn/inkweave repository as a submodule. This allows the admin project to:
- Reference specific commits of the core application.
- Isolate admin-specific code from the public repository.
- Maintain custom configurations in the
upstream/inkweavedirectory.
Sources: README.md:3-4
Deployment Customization
Inkweave-admin deploys to a unique Vercel project. This environment is customized to include a Vercel login requirement, ensuring that administrative tools remain private even if the core application logic is shared with the public version.
Sources: README.md:4-5
System Relationship
The following diagram illustrates the relationship between the admin tools and the core Inkweave repository.
The diagram shows how the admin repository acts as a gatekeeper and wrapper for the core logic.
Sources: README.md:1-5
Configuration Summary
The project utilizes specific files to manage planning, rules, and integration.
| Configuration File | Purpose |
|---|---|
docs/PLAN.md | Tracks design, planning, and phase status for administrative features. |
CLAUDE.md | Defines working rules and coding standards for the repository. |
upstream/inkweave | Acts as the pointer to the core application submodule. |
Sources: README.md:7-8
Customization Logic
Customization is driven by the project's development rules and phase-based planning.
- Phase Tracking: You must check
docs/PLAN.mdto determine the current implementation status of customization features. - Standardized Rules: You follow the guidelines in
CLAUDE.mdto ensure code consistency during the addition of administrative modules. - Submodule Pinning: You update the submodule at
upstream/inkweaveto pull in specific updates from the core repository that require administrative oversight.
Sources: README.md:7-8
Inkweave-admin achieves customization by decoupling administrative tools from the core public application while maintaining a direct link via submodules. This structure ensures that theming and functionality remain synchronized with the main platform while enforcing strict access control through Vercel-based authentication.