Developer
2.6 KiB
2.6 KiB
docs/features
dir: docs/features
index: docs/features/.pi-map.index.md
role
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, 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
Flat markdown-based documentation structure organized by feature domain, covering authentication, project/workspace management, Git operations, containerized terminals, and user preferences.
tags
git, documents, terminal, troubleshooting, management, workspace, tool, application