alex
fb0f2f7b9b
- Remove inline edit modal from projects listing page - Add Settings link to project cards navigating to /projects/:id/settings - Reposition Open Workspace button to rightmost action for easier access - Update tests for new UI flow - Update documentation to reflect new editing workflow - Sync specs: frontend-foundation and project-management Quality gates: npm run lint passed
79 lines
2.5 KiB
Markdown
79 lines
2.5 KiB
Markdown
# Project Management
|
|
|
|
## Overview
|
|
|
|
Projects are the top-level organizational unit in Headquarter. Each project can contain multiple git repositories and serves as a workspace for related development work.
|
|
|
|
## How to Use
|
|
|
|
### Creating a Project
|
|
|
|
1. Navigate to the **Projects** page from the sidebar
|
|
2. Click the **"New Project"** button
|
|
3. Enter a **name** for your project (required)
|
|
4. Optionally add a **description**
|
|
5. Click **"Create Project"**
|
|
|
|
### Viewing Projects
|
|
|
|
The Projects page displays all your projects in a card layout showing:
|
|
- Project name
|
|
- Description (if set)
|
|
- Creation date
|
|
- Associated repositories count
|
|
|
|
Each project card provides quick actions:
|
|
- **Settings** — Navigate to the project settings page
|
|
- **Delete** — Delete the project with confirmation
|
|
- **Open Workspace** — Open the project's workspace (rightmost action)
|
|
|
|
### Opening a Project Workspace
|
|
|
|
Click the **"Open Workspace"** button on any project card to open its **workspace**. The workspace is the default view for a project and shows:
|
|
- Repository file browser
|
|
- Branch selector
|
|
- File viewer
|
|
|
|
### Editing a Project
|
|
|
|
1. From the Projects page, click the **"Settings"** link on a project card
|
|
2. On the project settings page, update the **name** or **description**
|
|
3. Click **"Save Changes"**
|
|
|
|
The settings page also provides access to repository management and member settings.
|
|
|
|
### Deleting a Project
|
|
|
|
1. From the Projects page, click the **"Delete"** button on a project card
|
|
2. Confirm the deletion
|
|
|
|
**Note:** Deleting a project also deletes all associated repositories and their data. This action cannot be undone.
|
|
|
|
## Project Workspace
|
|
|
|
The project workspace is the default view when you click on a project. It provides:
|
|
|
|
- **Repository Browser**: Navigate files and directories
|
|
- **File Viewer**: View file contents with syntax highlighting
|
|
- **Branch Management**: Switch between branches
|
|
- **Repository Switcher**: Switch between project repositories
|
|
|
|
See [Repository Workspace](workspace.md) for detailed documentation.
|
|
|
|
## API Reference
|
|
|
|
### Endpoints
|
|
|
|
- `GET /projects` - List all projects
|
|
- `POST /projects` - Create a new project
|
|
- `GET /projects/{id}` - Get project details
|
|
- `PUT /projects/{id}` - Update a project
|
|
- `DELETE /projects/{id}` - Delete a project
|
|
|
|
See [Projects API](../api/projects.md) for detailed endpoint documentation.
|
|
|
|
## Related Features
|
|
|
|
- [Repository Workspace](workspace.md) - Browse and edit repository files
|
|
- [Git Repositories](repositories.md) - Manage project repositories
|