chore(project-map): regenerate .pi-map artifacts across the repo
This commit is contained in:
Developer
@@ -2,7 +2,7 @@
|
||||
dir: docs
|
||||
|
||||
## role
|
||||
Central documentation hub and navigation entry point for the Headquarter platform.
|
||||
Provides user-facing documentation and knowledge base for the Headquarter platform.
|
||||
## parent
|
||||
index: ./.pi-map.index.md
|
||||
map: ./.pi-map.md
|
||||
|
||||
+4
-4
@@ -4,13 +4,13 @@ dir: docs
|
||||
index: docs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Central documentation hub and knowledge base for the Headquarter platform.
|
||||
Provides user-facing documentation and knowledge base for the Headquarter platform.
|
||||
## files
|
||||
- README.md | Serves as the main index and navigation hub for the Headquarter platform documentation, organizing links to feature guides, API docs, architecture, deployment, and development resources.
|
||||
- README.md | Serves as the main index/landing page for the Headquarter platform documentation, organizing links to feature guides, API docs, architecture, deployment, and development resources.
|
||||
## arch
|
||||
Static documentation organization using hierarchical markdown files with cross-referenced navigation structure.
|
||||
Static documentation site using markdown files organized by topic (features, API, architecture, deployment, development).
|
||||
## tags
|
||||
readme, serves, main, index, navigation, hub, headquarter, platform
|
||||
readme, serves, main, index, landing, page, headquarter, platform
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/api
|
||||
|
||||
## role
|
||||
Provides comprehensive API documentation for the Headquarter platform's REST and WebSocket endpoints, covering authentication, project management, infrastructure tooling, and interactive terminal access.
|
||||
Documents the REST API and WebSocket interfaces for the platform's core services including authentication, project management, tool instances, and interactive terminal access.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
+11
-11
@@ -4,21 +4,21 @@ dir: docs/api
|
||||
index: docs/api/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides comprehensive API documentation for the Headquarter platform's REST and WebSocket endpoints, covering authentication, project management, infrastructure tooling, and interactive terminal access.
|
||||
Documents the REST API and WebSocket interfaces for the platform's core services including authentication, project management, tool instances, and interactive terminal access.
|
||||
## files
|
||||
- README.md | API documentation for a FastAPI-based Headquarter REST API describing authentication, endpoints, and testing | dep: FastAPI, REST API, session cookie authentication, JSON
|
||||
- README.md | Provides documentation for a RESTful API built with FastAPI, covering authentication, response formats, endpoint sections, and interactive testing. | dep: FastAPI
|
||||
- auth.md | Documents OAuth2 authentication API endpoints for Authentik-based login flow with session management | dep: Authentik, OAuth2, session cookies
|
||||
- config-profiles.md | Documents a configuration profile system with git repository mounting capabilities for tool instances, including API endpoints, validation rules, and profile resolution with merge/override semantics. | dep: git repositories, tool instances, container filesystem, SSH keys, glob pattern matching
|
||||
- projects.md | Documents a REST API for project management with CRUD operations.
|
||||
- repositories.md | Documents a REST API for managing Git repositories, files, branches, and commits within projects.
|
||||
- ssh-keys.md | Documents a REST API for managing user SSH keys including listing, generating, and deleting key pairs
|
||||
- terminal.md | Documents a WebSocket-based Terminal API for interactive terminal access to running tool instance containers with session persistence and heartbeat mechanisms. | dep: WebSocket, HTTP, JSON, UUID, session cookies, terminal/shell emulation
|
||||
- tool-types.md | Documents REST API endpoints for managing Docker Compose-based tool types with template variable support
|
||||
- users.md | Documents a REST API for user profile management, avatar uploads, and user-configurable settings.
|
||||
- config-profiles.md | Documents an API for managing reusable configuration profiles with git repository mounting capabilities for tool instances | dep: git, filesystem, API endpoints, JSON
|
||||
- projects.md | Documents a REST API for project management with CRUD operations
|
||||
- repositories.md | Documents REST API endpoints for Git repository management and file operations within a project-based system.
|
||||
- ssh-keys.md | Documents a REST API for SSH key management including listing, generating, and deleting user SSH keys
|
||||
- terminal.md | Documents a WebSocket-based Terminal API for interactive terminal access to running tool instance containers with session persistence and heartbeat management. | dep: WebSocket, HTTP, JSON, UUID, terminal/shell, container runtime
|
||||
- tool-types.md | Documents REST API endpoints for managing Docker Compose-based tool types with built-in vs custom differentiation
|
||||
- users.md | Documents a REST API for user profile management, avatar uploads, and user configuration settings.
|
||||
## arch
|
||||
Documentation-as-code structure organized by domain entity with FastAPI-style endpoint documentation, following standard HTTP method conventions (GET/POST/PUT/DELETE) with WebSocket extensions for real-time features, and OAuth2/session-based authentication patterns.
|
||||
FastAPI-based RESTful API with OAuth2/Authentik authentication, WebSocket support for real-time features, resource-oriented endpoint organization, and CRUD patterns across project-scoped resources with git integration and container-based tooling.
|
||||
## tags
|
||||
api, documents, rest, tool, terminal, endpoints, management, profile
|
||||
api, documents, management, tool, rest, terminal, ssh, endpoints
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/architecture
|
||||
|
||||
## role
|
||||
Provides technical documentation for the "Headquarter" application's system architecture across all layers.
|
||||
Documents the technical architecture and design decisions for the "Headquarter" full-stack web application across all system layers.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
@@ -4,16 +4,16 @@ dir: docs/architecture
|
||||
index: docs/architecture/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides technical documentation for the "Headquarter" application's system architecture across all layers.
|
||||
Documents the technical architecture and design decisions for the "Headquarter" full-stack web application across all system layers.
|
||||
## files
|
||||
- backend.md | Documents the layered backend architecture of a FastAPI application with authentication, real-time monitoring, and service management. | dep: FastAPI, SQLAlchemy, asyncpg, Pydantic, Alembic, httpx, pytest, Authentik, Docker
|
||||
- database.md | Documents the PostgreSQL database schema, relationships, and operational procedures for a "Headquarter" application managing users, projects, git repositories, SSH keys, user configs, and tool types. | dep: PostgreSQL, SQLAlchemy ORM, Alembic, Authentik, Docker Compose
|
||||
- deployment.md | Documents the containerized deployment architecture, infrastructure components, and operational strategies for a web application called "Headquarter" | dep: Docker, Traefik, React, Vite, nginx, FastAPI, Python 3.11, PostgreSQL 15, Redis 7, Authentik, PgBouncer, alembic
|
||||
- database.md | Documents the PostgreSQL database schema, relationships, and operational details for the Headquarter application | dep: PostgreSQL, SQLAlchemy, Alembic, Authentik, Docker Compose, PgBouncer
|
||||
- deployment.md | Documents the containerized deployment architecture for a web application called "Headquarter" using Docker, Traefik, and microservices. | dep: Docker, Traefik, React, Vite, nginx, FastAPI, Python 3.11, PostgreSQL 15, Redis 7, Authentik, OAuth2/OIDC, Alembic, PgBouncer
|
||||
- frontend.md | Documents the frontend architecture for a React-based SPA called "Headquarter" with modular design patterns, real-time SSE events, and OAuth authentication. | dep: React, React Router, Vite, TypeScript, Vitest, React Testing Library, Authentik OAuth
|
||||
## arch
|
||||
Documentation-as-code approach with markdown files organized by architectural concern (backend, database, deployment, frontend) covering a full-stack FastAPI/React/PostgreSQL system with real-time features and containerized deployment.
|
||||
Markdown-based architecture decision records (ADRs) covering four-tier documentation structure: backend (FastAPI), frontend (React SPA), database (PostgreSQL), and deployment (Docker/Traefik microservices).
|
||||
## tags
|
||||
documents, backend, architecture, fastapi, application, alembic, authentik, database
|
||||
documents, backend, architecture, fastapi, application, alembic, authentik, docker
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -6,12 +6,12 @@ index: docs/architecture/decisions/.pi-map.index.md
|
||||
## role
|
||||
Documents key architectural decisions made during the project's development to provide historical context and rationale for technology choices.
|
||||
## files
|
||||
- adr-001-session-auth.md | Documents the architectural decision to use session-based authentication with HMAC-signed httpOnly cookies for OAuth2 flow instead of JWT alternatives | dep: Authentik, Traefik, OAuth2, HMAC-SHA256
|
||||
- adr-002-async-sqlalchemy.md | Architecture decision record documenting the choice to use SQLAlchemy 2.0 with async PostgreSQL via asyncpg for an async-capable Python application | dep: SQLAlchemy 2.0, PostgreSQL, asyncpg, Alembic
|
||||
- adr-001-session-auth.md | Documents the architectural decision to use session-based authentication with HMAC-signed httpOnly cookies for an OAuth2 application. | dep: Authentik, Traefik, OAuth2, HMAC-SHA256
|
||||
- adr-002-async-sqlalchemy.md | Architecture Decision Record documenting the choice to use SQLAlchemy 2.0 with async PostgreSQL via asyncpg for an async-capable Python application | dep: SQLAlchemy 2.0, PostgreSQL, asyncpg, Alembic
|
||||
## arch
|
||||
Lightweight ADR (Architecture Decision Record) pattern using numbered, markdown-formatted documents with consistent structure covering context, decision, consequences, and status.
|
||||
Lightweight ADR (Architecture Decision Record) pattern using numbered markdown files with consistent naming convention (adr-NNN-title.md) for traceable, versioned decision documentation.
|
||||
## tags
|
||||
adr, async, session, sqlalchemy, decision, hmac, oauth2, 001
|
||||
adr, async, session, sqlalchemy, decision, hmac, oauth2, application
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/deployment
|
||||
|
||||
## role
|
||||
Provides operational documentation for deploying, configuring, and securing the Headquarter application in production environments.
|
||||
Provides deployment and infrastructure documentation for the Headquarter application, covering containerization, reverse proxy, authentication, and environment configuration.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
@@ -4,16 +4,16 @@ dir: docs/deployment
|
||||
index: docs/deployment/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides operational documentation for deploying, configuring, and securing the Headquarter application in production environments.
|
||||
Provides deployment and infrastructure documentation for the Headquarter application, covering containerization, reverse proxy, authentication, and environment configuration.
|
||||
## files
|
||||
- authentik.md | Documents how to configure Authentik as an OAuth2 provider for the Headquarter application | dep: Authentik, Headquarter, OAuth2, Python
|
||||
- docker.md | Provides deployment instructions for a multi-container "Headquarter" application using Docker Compose in development and production environments | dep: Docker, Docker Compose, FastAPI, React, Vite, PostgreSQL, Redis, Traefik, Alembic, Authentik, Let's Encrypt
|
||||
- environment.md | Documents all environment variables used by the Headquarter application, including their defaults, construction rules, and security requirements.
|
||||
- traefik.md | Documents how to configure and deploy Traefik as a reverse proxy with automatic HTTPS for a "Headquarter" application using Docker Compose and Docker labels. | dep: Traefik, Docker, Docker Compose, Let's Encrypt, DNS
|
||||
- authentik.md | Documents the configuration steps for integrating Authentik as an OAuth2 provider with the Headquarter application | dep: Authentik, Headquarter, OAuth2, Python
|
||||
- docker.md | Documentation for deploying a multi-container "Headquarter" application using Docker Compose with development and production configurations | dep: Docker, Docker Compose, FastAPI, React, Vite, PostgreSQL, Redis, Traefik, Alembic, Authentik, Let's Encrypt, Alpine
|
||||
- environment.md | Documents all environment variables used by the Headquarter application, including their defaults, descriptions, and configuration examples for different environments.
|
||||
- traefik.md | Documents how to configure and deploy Traefik as a reverse proxy and load balancer for the "Headquarter" application using Docker Compose with automatic HTTPS via Let's Encrypt. | dep: Traefik, Docker Compose, Let's Encrypt, DNS, Docker, Alembic
|
||||
## arch
|
||||
Documentation-as-code pattern covering containerized deployment (Docker Compose), reverse proxy routing (Traefik), identity federation (Authentik OAuth2), and environment-based configuration management.
|
||||
Documentation-as-code approach with modular environment-specific guides following standard DevOps patterns: Docker Compose for container orchestration, Traefik for edge routing with automatic HTTPS, Authentik for identity federation via OAuth2, and centralized environment variable management for twelve-factor app configuration.
|
||||
## tags
|
||||
docker, authentik, headquarter, traefik, application, documents, environment, configure
|
||||
docker, authentik, headquarter, traefik, application, documents, environment, configuration
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/development
|
||||
|
||||
## role
|
||||
Developer documentation hub providing setup, contribution, quality, and testing guidelines for the Headquarter full-stack project.
|
||||
Provides comprehensive documentation for developers contributing to the Headquarter full-stack web application project.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
@@ -13,6 +13,7 @@ map: docs/.pi-map.md
|
||||
- quality-gates.md
|
||||
- setup.md
|
||||
- testing.md
|
||||
- ui-review-checklist.md
|
||||
## links
|
||||
index: docs/development/.pi-map.index.md
|
||||
map: docs/development/.pi-map.md
|
||||
|
||||
@@ -4,16 +4,17 @@ dir: docs/development
|
||||
index: docs/development/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Developer documentation hub providing setup, contribution, quality, and testing guidelines for the Headquarter full-stack project.
|
||||
Provides comprehensive documentation for developers contributing to the Headquarter full-stack web application project.
|
||||
## files
|
||||
- contributing.md | Provides guidelines and workflows for contributing to the Headquarter project | dep: git, ruff, mypy, pytest, npm, React, TypeScript, Python
|
||||
- quality-gates.md | Defines mandatory quality gates (linting, type checking, testing, security, build) for backend (Python) and frontend (TypeScript) code before merge, including CI/CD integration and IDE setup. | dep: ruff, mypy, pytest, bandit, safety, TypeScript, ESLint, Vitest, pre-commit, npm, make
|
||||
- setup.md | Provides step-by-step instructions for setting up a full-stack development environment for a FastAPI/React application with PostgreSQL, Redis, and optional Authentik authentication. | dep: Python 3.11+, Node.js 18+, PostgreSQL 15+, Redis 7+, Git, Docker, FastAPI, React, Alembic, uvicorn, npm, Authentik
|
||||
- testing.md | Documents testing practices, frameworks, and guidelines for both backend (Python/pytest) and frontend (React/Vitest) of a web application called "Headquarter" | dep: pytest, pytest-asyncio, httpx, factory-boy, vitest, react-testing-library, jsdom, playwright, asyncpg, postgresql, authentik, github-actions
|
||||
- contributing.md | Provides guidelines and workflows for contributing to the Headquarter project, including setup, development workflow, code standards, testing, documentation, and review processes.
|
||||
- quality-gates.md | Defines mandatory quality gates and tooling configuration for backend (Python) and frontend (TypeScript/React) code before merging changes. | dep: ruff, mypy, pytest, bandit, safety, pre-commit, TypeScript, ESLint, Vitest, npm, make, GitLab CI
|
||||
- setup.md | Provides step-by-step instructions for setting up a local development environment for a full-stack web application with FastAPI backend, React frontend, PostgreSQL database, Redis cache, and optional Authentik authentication. | dep: Python, Node.js, PostgreSQL, Redis, Git, Docker, FastAPI, React, uvicorn, alembic, npm, Authentik
|
||||
- testing.md | Documentation guide for backend, frontend, and E2E testing practices in the Headquarter application | dep: pytest, pytest-asyncio, httpx, factory-boy, Vitest, React Testing Library, jsdom, Playwright, PostgreSQL, GitHub Actions
|
||||
- ui-review-checklist.md | Defines a checklist for reviewing UI changes to ensure compliance with design token standards and accessibility practices.
|
||||
## arch
|
||||
Static markdown documentation organized by concern (setup, contributing, quality, testing) with explicit FastAPI/Python backend and React/TypeScript frontend toolchain boundaries.
|
||||
Documentation-as-code pattern with structured markdown files covering setup, standards, quality gates, testing, and review processes for a FastAPI/React/PostgreSQL/Redis stack.
|
||||
## tags
|
||||
pytest, react, testing, contributing, npm, typescript, python, quality
|
||||
testing, contributing, setup, review, quality, gates, backend, frontend
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/features
|
||||
|
||||
## role
|
||||
User-facing documentation for features of a web-based development platform called "Headquarter" that provides project management, Git repositories, containerized development tools, and browser-based IDE capabilities.
|
||||
Documentation package describing user-facing features of the Headquarter web-based development platform.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
+13
-13
@@ -4,22 +4,22 @@ dir: docs/features
|
||||
index: docs/features/.pi-map.index.md
|
||||
|
||||
## role
|
||||
User-facing documentation for features of a web-based development platform called "Headquarter" that provides project management, Git repositories, containerized development tools, and browser-based IDE capabilities.
|
||||
Documentation package describing user-facing features of the Headquarter web-based development platform.
|
||||
## files
|
||||
- auth.md | Documents the OAuth2 authentication system using Authentik for the Headquarter application | dep: Authentik, OAuth2, session cookies
|
||||
- git-history.md | Documents a Git history visualization UI feature showing commit graphs, branch filtering, and commit details with diff viewing | dep: Git, repositories API, branch selector UI component, diff syntax highlighter
|
||||
- projects.md | Documentation for project management functionality in a software application called Headquarter
|
||||
- repositories.md | Documents how to create, manage, and interact with Git repositories within a project-based system | dep: Git, SSH, GitHub, GitLab, API endpoints
|
||||
- settings.md | Documentation for user settings functionality in a Headquarter application, covering theme preferences, git identity, and default editor configuration.
|
||||
- ssh-keys.md | Document SSH key management functionality for git authentication in an application
|
||||
- terminal-troubleshooting.md | Provides troubleshooting guidance for diagnosing and resolving terminal connection and functionality issues in a web-based terminal system | dep: WebSocket, Docker, browser DevTools, API server, terminal session management
|
||||
- terminal.md | Documents terminal session functionality for browser-based interactive shell access to containerized tool instances
|
||||
- tool-types.md | Documents how to define, manage, and use development tool types in Headquarter using Docker Compose templates | dep: Docker Compose, YAML, git, VS Code Server, Jupyter Notebook
|
||||
- workspace.md | Documents a repository workspace file browser interface with repository/branch selection, file tree navigation, file viewing with syntax highlighting, and quick editing capabilities. | dep: Git, Repositories API, Git History, Git Repositories
|
||||
- auth.md | Documents the OAuth2 authentication system using Authentik for the Headquarter application, including user flows, technical implementation, API endpoints, configuration, and troubleshooting. | dep: Authentik, OAuth2, session cookies
|
||||
- git-history.md | Documentation for a Git history visualization feature in a web application, showing commit graphs, branch filtering, and detailed commit inspection | dep: Git, web UI framework, repositories API, diff rendering engine
|
||||
- projects.md | Documentation for project management features in the Headquarter application, covering CRUD operations, workspace navigation, and API endpoints. | dep: workspace.md, repositories.md, ../api/projects.md
|
||||
- repositories.md | Documents Git repository management features including creation, cloning, URL parsing, and deletion within a project-based system.
|
||||
- settings.md | Documents user settings functionality for a "Headquarter" application, including theme preferences, git identity, and default editor configuration.
|
||||
- ssh-keys.md | Documents SSH key management functionality for generating, storing, and using Ed25519 key pairs to authenticate with git remotes. | dep: Git repositories, SSH Keys API
|
||||
- terminal-troubleshooting.md | Provides troubleshooting guidance for diagnosing and resolving terminal connection and connectivity issues in a web-based tool instance environment. | dep: WebSocket, Docker, browser DevTools, REST API, terminal session management
|
||||
- terminal.md | Documentation explaining browser-based persistent terminal sessions for containerized tool instances, including features, troubleshooting, and session management.
|
||||
- tool-types.md | Documents development tool type definitions and management for a platform that spawns containerized development environments via Docker Compose templates. | dep: Docker Compose, YAML, git, VS Code Server (linuxserver/code-server), Jupyter Notebook (jupyter/scipy-notebook), OpenCode
|
||||
- workspace.md | Documents a repository workspace UI feature for browsing, viewing, and editing files in git repositories through a web interface. | dep: Git repositories, file tree viewer, syntax highlighting, REST API
|
||||
## arch
|
||||
Feature-oriented documentation structure with each markdown file independently documenting a distinct system capability; content follows a consistent pattern of overview, usage instructions, and UI element descriptions; docs cover a full-stack developer platform spanning authentication (OAuth2/Authentik), Git operations, Docker-based tooling, and in-browser terminals/editors.
|
||||
Flat markdown-based documentation structure organized by feature domain, covering authentication, project/workspace management, Git operations, containerized terminals, and user preferences.
|
||||
## tags
|
||||
git, terminal, documents, functionality, headquarter, application, ssh, tool
|
||||
git, documents, terminal, troubleshooting, management, workspace, tool, application
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/guides
|
||||
|
||||
## role
|
||||
Provides user-facing documentation for advanced configuration features of the platform.
|
||||
Provides user-facing documentation for advanced configuration features.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
@@ -4,11 +4,11 @@ dir: docs/guides
|
||||
index: docs/guides/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides user-facing documentation for advanced configuration features of the platform.
|
||||
Provides user-facing documentation for advanced configuration features.
|
||||
## files
|
||||
- config-profiles-git-mounts.md | Documents how to mount files and directories from git repositories into tool instances via config profiles | dep: Git, container runtime (bind mounts), glob pattern matching
|
||||
- config-profiles-git-mounts.md | Documents how to mount files and directories from git repositories into tool instances using config profiles | dep: Git, container runtime (for bind mounts), config profile system
|
||||
## arch
|
||||
Flat markdown documentation structure with topic-specific guides.
|
||||
Static markdown documentation with no code, following standard technical writing patterns for feature guides.
|
||||
## tags
|
||||
git, config, profiles, mounts, documents, mount, directories, repositories
|
||||
## symbols
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/superpowers
|
||||
|
||||
## role
|
||||
Documentation for specialized capabilities or advanced features of the project.
|
||||
Documentation for special capabilities or advanced features of the project.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
@@ -4,10 +4,10 @@ dir: docs/superpowers
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Documentation for advanced or specialized features and capabilities of the project.
|
||||
Documentation for special capabilities or advanced features of the project.
|
||||
## files
|
||||
## arch
|
||||
Flat documentation structure with topic-based markdown files describing extended functionality beyond core features.
|
||||
Documentation-only directory with no code architecture; likely contains markdown or structured text files describing extended functionality.
|
||||
## tags
|
||||
-
|
||||
## symbols
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/superpowers/handoffs
|
||||
|
||||
## role
|
||||
Documents infrastructure migration procedures for development environment tooling.
|
||||
Documents a specific infrastructure migration task for tool container home directory configuration.
|
||||
## parent
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
|
||||
@@ -4,13 +4,13 @@ dir: docs/superpowers/handoffs
|
||||
index: docs/superpowers/handoffs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Documents infrastructure migration procedures for development environment tooling.
|
||||
Documents a specific infrastructure migration task for tool container home directory configuration.
|
||||
## files
|
||||
- tool-container-home-directory.md | Documents a multi-phase implementation plan for changing tool container home directories from `/workspace` to `/home/user` while preserving repo root directory names in mount targets and maintaining backward compatibility. | dep: alembic, docker, python, pydantic/sqlalchemy models, manifest compiler, instance service, config profile resolver, permission fixer
|
||||
- tool-container-home-directory.md | Documents the implementation plan and progress for changing tool container home directories from `/workspace` to `/home/user` while preserving repo/workspace name in mount targets. | dep: Alembic, Docker, Docker Compose, Python, SQLAlchemy, tool-images/base.dockerfile
|
||||
## arch
|
||||
Technical documentation following phased implementation pattern with backward compatibility considerations.
|
||||
Documentation-as-code pattern tracking implementation progress of a filesystem mount target migration from `/workspace` to `/home/user` with backward compatibility considerations.
|
||||
## tags
|
||||
home, tool, container, directory, documents, multi, phase, implementation
|
||||
tool, home, container, workspace, directory, documents, implementation, plan
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/superpowers/plans
|
||||
|
||||
## role
|
||||
Contains dated implementation planning documents that specify step-by-step technical approaches for major infrastructure, authentication, database, and UI feature development.
|
||||
Contains architectural implementation plans and design documents for major system features and infrastructure changes.
|
||||
## parent
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
|
||||
@@ -4,17 +4,17 @@ dir: docs/superpowers/plans
|
||||
index: docs/superpowers/plans/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Contains dated implementation planning documents that specify step-by-step technical approaches for major infrastructure, authentication, database, and UI feature development.
|
||||
Contains architectural implementation plans and design documents for major system features and infrastructure changes.
|
||||
## files
|
||||
- 2024-05-16-docker-infrastructure.md | Defines a step-by-step implementation plan for setting up a complete Docker-based development infrastructure with multi-service orchestration including PostgreSQL, Redis, Traefik, Authentik, FastAPI backend, and React frontend. | dep: Docker, Docker Compose, Make, Python 3.11, Node.js 20, PostgreSQL, Redis, Traefik, Authentik, FastAPI, React, Vite, nginx, alembic, uvicorn, SQLAlchemy, pydantic, structlog
|
||||
- 2026-05-17-auth-oauth.md | Implementation plan for adding Authentik-backed OIDC authentication with JWT access tokens and DB-backed refresh tokens to a FastAPI application | dep: FastAPI, SQLAlchemy, Alembic, python-jose, httpx, pytest, Authentik, PostgreSQL
|
||||
- 2026-05-17-database-models.md | Define an implementation plan for building SQLAlchemy 2.0 async database models, Alembic migrations, and seed data for a FastAPI backend. | dep: SQLAlchemy 2.x, asyncpg, Alembic, pytest, pytest-asyncio, Pydantic Settings, PostgreSQL, FastAPI
|
||||
- 2026-05-24-session-branch-selection.md | Implementation plan for replacing free-text branch input with a dropdown of available branches and adding "Create new branch" functionality in a session creation form | dep: React, TypeScript, FastAPI, Python, Git subprocess, Pydantic, API client
|
||||
- tool-container-home-directory.md | Implementation plan to make `/home/user` the configurable default home directory for tool containers while preserving repository name in mount targets, migrating legacy tool types, and maintaining `/workspace` backward compatibility symlink. | dep: Alembic, Docker, Compose, manifest compiler, instance service, config profile resolver, permission fixer, base dockerfile, pytest
|
||||
- 2024-05-16-docker-infrastructure.md | Plan for implementing a complete Docker-based development infrastructure with multi-service orchestration including PostgreSQL, Redis, Traefik, Authentik, FastAPI backend, and React frontend | dep: Docker, Docker Compose, Make, Python 3.11, Node.js 20, PostgreSQL, Redis, Traefik, Authentik, FastAPI, React, Vite, nginx, uvicorn, SQLAlchemy, alembic, pydantic
|
||||
- 2026-05-17-auth-oauth.md | Implementation plan for adding Authentik-backed OIDC authentication with JWT access tokens and database-backed refresh tokens to a FastAPI application | dep: FastAPI, SQLAlchemy, Alembic, python-jose, httpx, pytest, PostgreSQL, Authentik
|
||||
- 2026-05-17-database-models.md | Define an implementation plan for building SQLAlchemy 2.0 async database models with Alembic migrations and seed data for a FastAPI backend. | dep: SQLAlchemy 2.x, asyncpg, Alembic, pytest, pytest-asyncio, Pydantic Settings, PostgreSQL, FastAPI, superpowers:subagent-driven-development
|
||||
- 2026-05-24-session-branch-selection.md | Implementation plan for replacing free-text branch input with a dropdown of available branches and adding "Create new branch" functionality in a session creation form | dep: React, TypeScript, FastAPI, Python, Git, subprocess, Pydantic
|
||||
- tool-container-home-directory.md | Implementation plan for migrating tool containers from `/workspace` to configurable `/home/user` home directory with backward compatibility symlink and repository name preservation | dep: Alembic, Docker, Docker Compose, Python (SQLAlchemy, Jinja2), pytest, npm/TypeScript
|
||||
## arch
|
||||
Document-driven planning architecture using chronological Markdown specifications with precise technical scope, dependencies, and migration strategies for incremental system evolution.
|
||||
Markdown-based technical specification documents using dated versioning, covering full-stack concerns (Docker orchestration, auth, database, UI/UX, container tooling) with detailed step-by-step implementation guidance for complex cross-cutting changes.
|
||||
## tags
|
||||
05, fastapi, 2026, implementation, plan, docker, alembic, postgresql
|
||||
05, fastapi, 2026, plan, docker, alembic, postgresql, authentik
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
dir: docs/superpowers/specs
|
||||
|
||||
## role
|
||||
Contains design specifications and test plans for upcoming features ("superpowers") being planned for the project.
|
||||
Contains technical design specifications and test plans for upcoming features, serving as the project's architectural decision record and implementation blueprint repository.
|
||||
## parent
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
|
||||
@@ -4,15 +4,15 @@ dir: docs/superpowers/specs
|
||||
index: docs/superpowers/specs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Contains design specifications and test plans for upcoming features ("superpowers") being planned for the project.
|
||||
Contains technical design specifications and test plans for upcoming features, serving as the project's architectural decision record and implementation blueprint repository.
|
||||
## files
|
||||
- 2026-05-17-auth-oauth-design.md | Design document for implementing OAuth2/OIDC authentication with Authentik, internal JWT access tokens, and database-backed refresh token rotation. | dep: Authentik, JWKS, JWT, database/PostgreSQL, cookies, pytest, mypy, ruff
|
||||
- 2026-05-24-session-branch-selection-design.md | Design document for replacing free-text branch input with a dropdown of available branches and adding the ability to create a new local branch at clone time in a session creation UI. | dep: React/TypeScript frontend, Python/FastAPI backend, Git, API client, ToolInstance database model
|
||||
- tool-container-home-directory-test-plan.md | Test plan and QA checklist for validating configurable home directory behavior in tool containers, covering manifest compilation, path expansion, database migrations, and mount target resolution. | dep: pytest, alembic, docker, compose, manifest compiler, instance service, ToolType, config profiles, git mounts
|
||||
- 2026-05-17-auth-oauth-design.md | Design document for implementing OAuth2/OIDC authentication via Authentik with internal JWT access tokens, DB-backed refresh token rotation, and secure cookie handling. | dep: Authentik, JWT library, database/ORM, web framework (implied), JWKS client, cookie handling library
|
||||
- 2026-05-24-session-branch-selection-design.md | Design document for replacing free-text branch input with a dropdown of available branches and adding the ability to create a new local branch at clone time in a session creation UI. | dep: React, TypeScript, Python, FastAPI, Pydantic, Git, API client, ToolInstance model
|
||||
- tool-container-home-directory-test-plan.md | This file is a comprehensive QA test plan for validating a configurable home directory feature in tool containers, covering unit tests, integration tests, manual QA checklist, and exit criteria for the implementation. | dep: pytest, alembic, docker, compose, manifest compiler, instance service, git mounts, config profiles, ToolType, workspace mounts, entrypoint permission fixer
|
||||
## arch
|
||||
Document-driven architecture using dated Markdown design documents for feature specifications, plus standalone test plans for QA validation of complex features.
|
||||
Markdown-based documentation with date-prefixed design documents following a chronological naming convention, plus standalone test plans; each spec isolates a single feature concern (auth, session UI, container configuration) with no code dependencies between documents.
|
||||
## tags
|
||||
design, 2026, 05, branch, database, session, test, plan
|
||||
design, 2026, 05, branch, session, test, plan, home
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
Vendored
+1
-1
@@ -2,7 +2,7 @@
|
||||
dir: docs/templates
|
||||
|
||||
## role
|
||||
Provides standardized markdown templates for consistent documentation of APIs, architecture, and features across the project.
|
||||
Provides standardized markdown templates for consistent documentation of API endpoints, system architecture, and product features across the project.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
|
||||
Vendored
+5
-5
@@ -4,15 +4,15 @@ dir: docs/templates
|
||||
index: docs/templates/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides standardized markdown templates for consistent documentation of APIs, architecture, and features across the project.
|
||||
Provides standardized markdown templates for consistent documentation of API endpoints, system architecture, and product features across the project.
|
||||
## files
|
||||
- api-endpoint.md | Provides a standardized markdown template for documenting REST API endpoints with sections for authentication, requests, responses, and examples.
|
||||
- api-endpoint.md | Provides a standardized markdown template for documenting REST API endpoints with request/response specifications and examples.
|
||||
- architecture.md | Provides a markdown template for documenting system architecture with standardized sections for components, data flow, technology stack, and operational considerations.
|
||||
- feature-doc.md | Markdown template for documenting software features with standardized sections
|
||||
- feature-doc.md | Provides a markdown template for documenting new product features with standardized sections covering overview, usage, API reference, configuration, and troubleshooting.
|
||||
## arch
|
||||
Template-based documentation system using structured markdown files with predefined sections to enforce uniformity and completeness in technical documentation.
|
||||
Template-based documentation pattern using structured, fill-in-the-section markdown files to enforce uniform documentation standards and reduce authoring overhead.
|
||||
## tags
|
||||
standardized, markdown, template, documenting, api, sections, architecture, provides
|
||||
api, provides, standardized, markdown, template, documenting, architecture, endpoint
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
Reference in New Issue
Block a user