Introduction & Goals

Inkweave-admin provides a private administrative interface for the Inkweave platform. It functions as a secure management layer that wraps the core application logic while maintaining strict access controls. The project primary serves to centralize administrative tools, design specifications, and development roadmaps for the Inkweave ecosystem.

Sources: README.md:3

System Architecture

The project utilizes a wrapper architecture to integrate the public application with administrative extensions. It maintains a reference to the main application repository as a core dependency.

Submodule Integration

The repository pins the public Inkweave application as a Git submodule located at upstream/inkweave. This structure allows the admin tools to access and extend the base application's components and logic while remaining a distinct, private entity.

Sources: README.md:3, .gitmodules

Deployment and Security

Inkweave-admin deploys to a dedicated Vercel project. To ensure the privacy of administrative functions, the deployment resides behind a Vercel login requirement, preventing unauthorized public access to the internal tools.

Sources: README.md:3, vercel.json

The diagram shows the relationship between the private admin tools, the authentication layer, and the public application submodule.

Project Governance and Planning

Administrative operations and development workflows follow specific guidelines and phase-based planning documented within the repository.

Documentation Structure

Key files define the operational boundaries and the future trajectory of the project:

Sources: README.md:5, docs/PLAN.md, CLAUDE.md

Core Goals

1. Restrict Access: Implement and maintain a secure administrative boundary using Vercel authentication.
2. Modular Dependency: Leverage the public Inkweave repository via submodules to ensure the admin tools stay synchronized with application updates.
3. Phase-Driven Development: Execute features according to the status defined in the design plan.
4. Standardized Workflow: Enforce development rules to maintain code quality and consistency across administrative modules.

Sources: README.md:3-5, docs/PLAN.md

Summary

Inkweave-admin serves as the secure control center for the Inkweave platform. By isolating administrative tools from the public codebase and enforcing authentication, the system ensures that sensitive management features remain private while staying integrated with the core application via Git submodules. Development follows a structured plan and set of rules to ensure project stability and clear progression through defined phases.