chore: track all project map and index files
Add generated .pi-map.md and .pi-map.index.md files across the repository so the project navigation maps are shared and versioned. These artifacts are maintained by project_map_init/patch/validate and must be kept in sync with source edits. Note: .cache/ remains ignored (added in previous commit).
This commit is contained in:
Developer
@@ -0,0 +1,42 @@
|
||||
# docs (index)
|
||||
dir: docs
|
||||
|
||||
## role
|
||||
Central documentation hub and knowledge base for the Headquarter platform, providing navigation and access to all project guides, API references, and technical resources.
|
||||
## parent
|
||||
index: ./.pi-map.index.md
|
||||
map: ./.pi-map.md
|
||||
## children
|
||||
- docs/api
|
||||
index: docs/api/.pi-map.index.md
|
||||
map: docs/api/.pi-map.md
|
||||
- docs/architecture
|
||||
index: docs/architecture/.pi-map.index.md
|
||||
map: docs/architecture/.pi-map.md
|
||||
- docs/deployment
|
||||
index: docs/deployment/.pi-map.index.md
|
||||
map: docs/deployment/.pi-map.md
|
||||
- docs/development
|
||||
index: docs/development/.pi-map.index.md
|
||||
map: docs/development/.pi-map.md
|
||||
- docs/features
|
||||
index: docs/features/.pi-map.index.md
|
||||
map: docs/features/.pi-map.md
|
||||
- docs/guides
|
||||
index: docs/guides/.pi-map.index.md
|
||||
map: docs/guides/.pi-map.md
|
||||
- docs/superpowers
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
- docs/templates
|
||||
index: docs/templates/.pi-map.index.md
|
||||
map: docs/templates/.pi-map.md
|
||||
## files
|
||||
- README.md
|
||||
## links
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,19 @@
|
||||
# docs
|
||||
dir: docs
|
||||
|
||||
index: docs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Central documentation hub and knowledge base for the Headquarter platform, providing navigation and access to all project guides, API references, and technical resources.
|
||||
## 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.
|
||||
## arch
|
||||
Static documentation structure using markdown-based content organization with hierarchical topic grouping (features, API, architecture, deployment, development) and a single-entry-point index pattern.
|
||||
## tags
|
||||
readme, serves, main, index, navigation, hub, headquarter, platform
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,27 @@
|
||||
# docs/api (index)
|
||||
dir: docs/api
|
||||
|
||||
## role
|
||||
Provides comprehensive API documentation for a FastAPI-based Headquarter REST API covering authentication, project management, repositories, SSH keys, terminal access, tool types, and user profiles.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- README.md
|
||||
- auth.md
|
||||
- config-profiles.md
|
||||
- projects.md
|
||||
- repositories.md
|
||||
- ssh-keys.md
|
||||
- terminal.md
|
||||
- tool-types.md
|
||||
- users.md
|
||||
## links
|
||||
index: docs/api/.pi-map.index.md
|
||||
map: docs/api/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,27 @@
|
||||
# docs/api
|
||||
dir: docs/api
|
||||
|
||||
index: docs/api/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides comprehensive API documentation for a FastAPI-based Headquarter REST API covering authentication, project management, repositories, SSH keys, terminal access, tool types, and user profiles.
|
||||
## 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
|
||||
- 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.
|
||||
## arch
|
||||
Standard REST API documentation structure organized by domain/resource with OAuth2/Authentik authentication, WebSocket for real-time terminal sessions, and git-backed configuration profile system with merge/override semantics.
|
||||
## tags
|
||||
api, documents, rest, tool, terminal, endpoints, management, profile
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,24 @@
|
||||
# docs/architecture (index)
|
||||
dir: docs/architecture
|
||||
|
||||
## role
|
||||
Documents the technical architecture and system design for the "Headquarter" full-stack application across all layers.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
- docs/architecture/decisions
|
||||
index: docs/architecture/decisions/.pi-map.index.md
|
||||
map: docs/architecture/decisions/.pi-map.md
|
||||
## files
|
||||
- backend.md
|
||||
- database.md
|
||||
- deployment.md
|
||||
- frontend.md
|
||||
## links
|
||||
index: docs/architecture/.pi-map.index.md
|
||||
map: docs/architecture/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/architecture
|
||||
dir: docs/architecture
|
||||
|
||||
index: docs/architecture/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Documents the technical architecture and system design for the "Headquarter" full-stack application across all 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
|
||||
- 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
|
||||
Markdown-based architectural decision records (ADRs) organized by domain (backend/frontend/database/deployment) using layered architecture patterns for a FastAPI+React+PostgreSQL stack with real-time capabilities and containerized deployment.
|
||||
## tags
|
||||
documents, backend, architecture, fastapi, application, alembic, authentik, database
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,20 @@
|
||||
# docs/architecture/decisions (index)
|
||||
dir: docs/architecture/decisions
|
||||
|
||||
## role
|
||||
Documents key architectural decisions for the project, providing rationale and context for technology choices around authentication and database access patterns.
|
||||
## parent
|
||||
index: docs/architecture/.pi-map.index.md
|
||||
map: docs/architecture/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- adr-001-session-auth.md
|
||||
- adr-002-async-sqlalchemy.md
|
||||
## links
|
||||
index: docs/architecture/decisions/.pi-map.index.md
|
||||
map: docs/architecture/decisions/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,20 @@
|
||||
# docs/architecture/decisions
|
||||
dir: docs/architecture/decisions
|
||||
|
||||
index: docs/architecture/decisions/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Documents key architectural decisions for the project, providing rationale and context for technology choices around authentication and database access patterns.
|
||||
## 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
|
||||
## arch
|
||||
Lightweight ADR (Architecture Decision Record) pattern using Markdown files with sequential numbering, each capturing context, decision, consequences, and alternatives considered for major technical choices.
|
||||
## tags
|
||||
adr, async, session, sqlalchemy, decision, hmac, oauth2, 001
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/deployment (index)
|
||||
dir: docs/deployment
|
||||
|
||||
## role
|
||||
Provides deployment documentation and operational guides for installing, configuring, and running the Headquarter application in production environments.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- authentik.md
|
||||
- docker.md
|
||||
- environment.md
|
||||
- traefik.md
|
||||
## links
|
||||
index: docs/deployment/.pi-map.index.md
|
||||
map: docs/deployment/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/deployment
|
||||
dir: docs/deployment
|
||||
|
||||
index: docs/deployment/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides deployment documentation and operational guides for installing, configuring, and running the Headquarter application in production environments.
|
||||
## 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
|
||||
## arch
|
||||
Documentation-as-code approach using Markdown files organized by infrastructure component (reverse proxy, identity provider, container orchestration, configuration management), following a modular microservices deployment pattern with Docker Compose.
|
||||
## tags
|
||||
docker, authentik, headquarter, traefik, application, documents, environment, configure
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/development (index)
|
||||
dir: docs/development
|
||||
|
||||
## role
|
||||
Developer onboarding and contribution standards documentation for the Headquarter full-stack web application project.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- contributing.md
|
||||
- quality-gates.md
|
||||
- setup.md
|
||||
- testing.md
|
||||
## links
|
||||
index: docs/development/.pi-map.index.md
|
||||
map: docs/development/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/development
|
||||
dir: docs/development
|
||||
|
||||
index: docs/development/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Developer onboarding and contribution standards documentation for 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
|
||||
## arch
|
||||
Documentation-as-code approach with structured markdown files covering environment setup, quality assurance gates, testing standards, and contribution workflows for a FastAPI/React/PostgreSQL/Redis stack.
|
||||
## tags
|
||||
pytest, react, testing, contributing, npm, typescript, python, quality
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,28 @@
|
||||
# docs/features (index)
|
||||
dir: docs/features
|
||||
|
||||
## role
|
||||
User-facing documentation for features of the "Headquarter" developer platform application, covering authentication, project/repository management, git tools, web-based terminals, and workspace editing.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- auth.md
|
||||
- git-history.md
|
||||
- projects.md
|
||||
- repositories.md
|
||||
- settings.md
|
||||
- ssh-keys.md
|
||||
- terminal-troubleshooting.md
|
||||
- terminal.md
|
||||
- tool-types.md
|
||||
- workspace.md
|
||||
## links
|
||||
index: docs/features/.pi-map.index.md
|
||||
map: docs/features/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,28 @@
|
||||
# docs/features
|
||||
dir: docs/features
|
||||
|
||||
index: docs/features/.pi-map.index.md
|
||||
|
||||
## role
|
||||
User-facing documentation for features of the "Headquarter" developer platform application, covering authentication, project/repository management, git tools, web-based terminals, and workspace editing.
|
||||
## 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
|
||||
## arch
|
||||
Flat markdown documentation structure organized by feature domain, with each file independently documenting a specific subsystem; no code or cross-references, purely descriptive end-user guides for a containerized development environment platform.
|
||||
## tags
|
||||
git, terminal, documents, functionality, headquarter, application, ssh, tool
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,19 @@
|
||||
# docs/guides (index)
|
||||
dir: docs/guides
|
||||
|
||||
## role
|
||||
Provides user-facing documentation for advanced configuration features
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- config-profiles-git-mounts.md
|
||||
## links
|
||||
index: docs/guides/.pi-map.index.md
|
||||
map: docs/guides/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,19 @@
|
||||
# docs/guides
|
||||
dir: docs/guides
|
||||
|
||||
index: docs/guides/.pi-map.index.md
|
||||
|
||||
## role
|
||||
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
|
||||
## arch
|
||||
Simple documentation-as-code with markdown files organized by feature topic
|
||||
## tags
|
||||
git, config, profiles, mounts, documents, mount, directories, repositories
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,23 @@
|
||||
# docs/superpowers (index)
|
||||
dir: docs/superpowers
|
||||
|
||||
## role
|
||||
Documentation directory for special capabilities or advanced features of the project.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
- docs/superpowers/plans
|
||||
index: docs/superpowers/plans/.pi-map.index.md
|
||||
map: docs/superpowers/plans/.pi-map.md
|
||||
- docs/superpowers/specs
|
||||
index: docs/superpowers/specs/.pi-map.index.md
|
||||
map: docs/superpowers/specs/.pi-map.md
|
||||
## files
|
||||
## links
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,18 @@
|
||||
# docs/superpowers
|
||||
dir: docs/superpowers
|
||||
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Documentation directory for special capabilities or advanced features of the project.
|
||||
## files
|
||||
## arch
|
||||
N/A (empty directory - no files to analyze)
|
||||
## tags
|
||||
-
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/superpowers/plans (index)
|
||||
dir: docs/superpowers/plans
|
||||
|
||||
## role
|
||||
Contains dated implementation planning documents that specify step-by-step technical approaches for major system features and infrastructure setup.
|
||||
## parent
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- 2024-05-16-docker-infrastructure.md
|
||||
- 2026-05-17-auth-oauth.md
|
||||
- 2026-05-17-database-models.md
|
||||
- 2026-05-24-session-branch-selection.md
|
||||
## links
|
||||
index: docs/superpowers/plans/.pi-map.index.md
|
||||
map: docs/superpowers/plans/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,22 @@
|
||||
# docs/superpowers/plans
|
||||
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 system features and infrastructure setup.
|
||||
## 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
|
||||
## arch
|
||||
Chronological planning document store using markdown files with ISO date prefixes; each plan follows a consistent structure of problem statement, proposed solution, implementation steps, and verification criteria, serving as architectural decision records and work specifications before code implementation.
|
||||
## tags
|
||||
05, fastapi, 2026, implementation, plan, docker, postgresql, authentik
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,20 @@
|
||||
# docs/superpowers/specs (index)
|
||||
dir: docs/superpowers/specs
|
||||
|
||||
## role
|
||||
Contains technical design specifications for planned system features, serving as architectural decision records and implementation blueprints for authentication and session management capabilities.
|
||||
## parent
|
||||
index: docs/superpowers/.pi-map.index.md
|
||||
map: docs/superpowers/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- 2026-05-17-auth-oauth-design.md
|
||||
- 2026-05-24-session-branch-selection-design.md
|
||||
## links
|
||||
index: docs/superpowers/specs/.pi-map.index.md
|
||||
map: docs/superpowers/specs/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,20 @@
|
||||
# docs/superpowers/specs
|
||||
dir: docs/superpowers/specs
|
||||
|
||||
index: docs/superpowers/specs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Contains technical design specifications for planned system features, serving as architectural decision records and implementation blueprints for authentication and session management capabilities.
|
||||
## 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
|
||||
## arch
|
||||
Markdown-based design documentation following a date-prefixed naming convention, with each spec detailing problem statements, proposed solutions, data models, API contracts, and security considerations for discrete feature increments.
|
||||
## tags
|
||||
design, 2026, 05, branch, session, document, authentik, jwt
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
Vendored
+21
@@ -0,0 +1,21 @@
|
||||
# docs/templates (index)
|
||||
dir: docs/templates
|
||||
|
||||
## role
|
||||
Provides standardized markdown templates for consistent documentation of APIs, architecture, and features across the project.
|
||||
## parent
|
||||
index: docs/.pi-map.index.md
|
||||
map: docs/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- api-endpoint.md
|
||||
- architecture.md
|
||||
- feature-doc.md
|
||||
## links
|
||||
index: docs/templates/.pi-map.index.md
|
||||
map: docs/templates/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
Vendored
+21
@@ -0,0 +1,21 @@
|
||||
# docs/templates
|
||||
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.
|
||||
## files
|
||||
- api-endpoint.md | Provides a standardized markdown template for documenting REST API endpoints with sections for authentication, requests, responses, 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
|
||||
## arch
|
||||
Template library pattern using structured markdown files with predefined section conventions to enforce documentation uniformity and reduce authoring overhead.
|
||||
## tags
|
||||
standardized, markdown, template, documenting, api, sections, architecture, provides
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
Reference in New Issue
Block a user