Project Plan & Roadmap

Relevant source files

The following files were used as context for generating this wiki page:

• README.md
• docs/PLAN.md
• CLAUDE.md
• package.json
• vercel.json

inkweave-admin provides a private suite of administrative tools for the Inkweave platform. This system manages internal operations while maintaining strict separation from the public application code.

The project operates as a wrapper around the core Inkweave application. It integrates the public repository as a submodule and deploys via Vercel. This architecture allows developers to build administrative interfaces without exposing sensitive logic in the public repo.

Sources: README.md:1-3, README.md:5-5

System Architecture

The architecture relies on a submodule relationship to sync with the main application. The inkweave-admin repository pins Doberjohn/inkweave at the upstream/inkweave path.

Core Components

The following diagram illustrates the relationship between the admin repository, the public submodule, and the deployment environment.

The diagram shows how the admin repository encompasses the submodule and configuration files to deliver a protected interface through Vercel.

Sources: README.md:3-3, README.md:5-5

Component Descriptions

Component	Description	Location
Admin Tools	Private utilities for managing Inkweave data and users.	/
Upstream Submodule	A pinned version of the public Inkweave application.	upstream/inkweave
Documentation	System design, roadmap phases, and status tracking.	docs/PLAN.md
Working Rules	Developer guidelines and operational standards.	CLAUDE.md

Sources: README.md:3-8

Deployment & Security

The system deploys to Vercel as a standalone project. Security is enforced at the infrastructure level to prevent unauthorized access to administrative functions.

Authentication Flow

Users must authenticate through Vercel before accessing the administrative dashboard. This provides a secure layer that is independent of the application's internal user authentication.

The sequence diagram details the gatekeeping process managed by Vercel's login protection.

Sources: README.md:3-3

Roadmap and Phases

Project development follows a structured plan documented in the docs directory. This plan tracks the evolution of admin tools through distinct implementation phases.

Development Workflow

1. Review docs/PLAN.md for current phase status.
2. Follow operational guidelines defined in CLAUDE.md.
3. Update the upstream/inkweave submodule to sync with public features.
4. Deploy updates to the Vercel project environment.

Sources: README.md:7-8, docs/PLAN.md

Project Configuration

Administrative tasks and build processes are managed via standard configuration files.

{
  "name": "inkweave-admin",
  "version": "0.1.0",
  "private": true,
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  }
}

Note: This configuration represents the standard structure for a Next.js project deployed on Vercel as implied by the repository structure.

Sources: package.json, vercel.json

Summary

inkweave-admin functions as a secure, private extension of the Inkweave ecosystem. It utilizes submodules to maintain synchronization with the public app while isolating administrative logic. Through Vercel login protection and a structured roadmap, the project provides a controlled environment for platform management.