Skip to content

Commit 280c5ac

Browse files
author
b45632
committed
docs: add page-by-page user guide
1 parent c53dd1a commit 280c5ac

11 files changed

Lines changed: 426 additions & 41 deletions

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,22 @@ The current interface is in German. This README uses the exact German button nam
4747
| Multi-project setup | **Workspaces** in the top bar | Starts several project actions together |
4848
| App configuration | **Einstellungen** in the top bar | IDE commands, templates, theme, folders and import/export |
4949

50+
## Documentation
51+
52+
For a detailed explanation of every page and feature, see the full user guide:
53+
54+
[Open the Code Deck documentation](docs/README.md)
55+
56+
57+
### Guides
58+
59+
- [Dashboard](docs/pages/dashboard.md)
60+
- [New Project](docs/pages/new-project.md)
61+
- [Project Details](docs/pages/project-details.md)
62+
- [Processes](docs/pages/processes.md)
63+
- [Workspaces](docs/pages/workspaces.md)
64+
- [Settings](docs/pages/settings.md)
65+
5066
## Adding projects
5167

5268
Click **Neues Projekt** on the dashboard. There are two modes.

docs/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Code Deck user guide
2+
3+
This guide explains the app page by page. The names in bold match the current German interface so the controls are easy to find.
4+
5+
## Pages
6+
7+
| Page | Use it for |
8+
|---|---|
9+
| [Dashboard](pages/dashboard.md) | Finding projects and using the most common shortcuts |
10+
| [New Project](pages/new-project.md) | Creating a starter project, copying a template or importing an existing folder |
11+
| [Project Details](pages/project-details.md) | Editing one project and using its IDE, terminal, commands and Git information |
12+
| [Processes](pages/processes.md) | Viewing live output and stopping commands |
13+
| [Workspaces](pages/workspaces.md) | Starting several projects and actions as one setup |
14+
| [Settings](pages/settings.md) | Configuring editors, terminal behavior, templates, theme and backups |
15+
| [Onboarding](pages/onboarding.md) | Completing the first setup or running it again |
16+
17+
## A useful way to think about Code Deck
18+
19+
- A **project** represents one local project folder.
20+
- A **command** represents something that can run inside that folder.
21+
- A **process** is one active or completed command run.
22+
- A **workspace** is a saved routine made from several project actions.
23+
- A **template** is a folder used as the starting point for a new project.
24+
25+
Code Deck keeps its own configuration locally. Adding a project does not move the project folder, and opening a project does not change its source files.

docs/architecture.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/config.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/pages/dashboard.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Dashboard
2+
3+
![Code Deck dashboard](../screenshots/dashboard.png)
4+
5+
The dashboard is the main page. It is meant for finding a project quickly and starting the action you use most often.
6+
7+
## Where to find it
8+
9+
The dashboard opens when Code Deck starts. Return to it by closing the current dialog or detail view.
10+
11+
## Main controls
12+
13+
| Control | What it does |
14+
|---|---|
15+
| Search field | Searches project names, paths, tags, frameworks and known Git branches |
16+
| **Favoriten** | Shows only projects marked with a star |
17+
| Framework or tag filters | Narrows the list without changing project data |
18+
| Sort control | Changes the order, for example by name or last use |
19+
| **Neues Projekt** | Opens the project creation and import dialog |
20+
| **Ordner scannen** | Searches below a selected folder for likely projects |
21+
| Star on a project card | Adds or removes the project from favorites |
22+
| **Details** | Opens the complete project page |
23+
| IDE quick action | Opens the project with its preferred editor |
24+
| Command quick action | Runs a saved command without opening the detail page |
25+
26+
## Typical flow
27+
28+
1. Type part of a project name into the search field.
29+
2. Open the project directly in its preferred IDE, or select **Details** for more options.
30+
3. Use the star for projects you open often.
31+
4. Use **Neues Projekt** when the project is not in Code Deck yet.
32+
33+
## Empty dashboard
34+
35+
When no projects have been added, start with **Neues Projekt**. Choose an existing folder when the project already exists, or choose a starter when Code Deck should create the initial files.
36+
37+
## What the dashboard does not do
38+
39+
Removing a card from Code Deck does not delete the project directory. Likewise, archiving a project only hides it from the normal list.

docs/pages/new-project.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# New Project
2+
3+
![New project dialog](../screenshots/new-project.png)
4+
5+
Open **Neues Projekt** from the dashboard. The dialog supports three different jobs: create a starter project, create from your own template, or add an existing folder.
6+
7+
## Create a starter project
8+
9+
Choose **Neues Projekt erstellen**, then select a starter such as Node.js, React, Spring Boot, Python or Rust.
10+
11+
You provide:
12+
13+
| Field | Meaning |
14+
|---|---|
15+
| Project name | The folder name and default display name |
16+
| Parent folder | The directory in which the new folder is created |
17+
| Starter | The base files Code Deck should generate |
18+
| Initialize Git | Runs `git init` after the files are created |
19+
| Preferred IDE | The editor used by the main open button |
20+
21+
Code Deck shows the final path before creating anything.
22+
23+
Dependencies are not installed automatically. This avoids running package-manager commands without a clear user action. For a generated React project, for example, open its terminal afterwards and run `pnpm install` or `npm install`.
24+
25+
## Use a custom template
26+
27+
Custom templates are ordinary local folders registered under **Einstellungen → Eigene Projektvorlagen**.
28+
29+
When you select one during project creation, Code Deck copies the template contents into the new project folder. These generated or repository-specific directories are skipped:
30+
31+
```text
32+
.git
33+
node_modules
34+
target
35+
dist
36+
build
37+
```
38+
39+
A template is useful when your projects usually begin with the same configuration, folder structure, scripts or internal defaults.
40+
41+
## Add an existing project
42+
43+
Choose **Vorhandenen Ordner hinzufügen** when the project is already on disk.
44+
45+
Code Deck reads common files such as:
46+
47+
```text
48+
package.json
49+
Cargo.toml
50+
pom.xml
51+
build.gradle
52+
pyproject.toml
53+
go.mod
54+
Dockerfile
55+
.git
56+
```
57+
58+
This information is used to suggest frameworks, tags and package scripts. The project files are not rewritten.
59+
60+
## Scan a base folder
61+
62+
Use **Ordner scannen** on the dashboard when many repositories are stored below one parent folder. The scan proposes likely projects; you still decide which ones are added.
63+
64+
## Common problems
65+
66+
**The folder already exists:** choose a different project name or parent folder, or add the existing folder instead.
67+
68+
**A starter command is unavailable:** generated files do not require the related runtime immediately, but running the project later still requires Node.js, Java, Python, Rust or the relevant toolchain.
69+
70+
**The preferred IDE is missing:** configure it first under **Einstellungen → IDEs**.

docs/pages/onboarding.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Onboarding
2+
3+
The onboarding guide appears on the first launch and can be opened again from **Einstellungen**.
4+
5+
## What it helps with
6+
7+
The guide covers the three things needed before Code Deck becomes useful:
8+
9+
1. choose or scan a folder containing projects
10+
2. configure at least one IDE
11+
3. add or create the first project
12+
13+
## Recommended first setup
14+
15+
1. Add VS Code, Cursor, IntelliJ IDEA or the editor you actually use.
16+
2. Set the default project folder.
17+
3. Add one existing project.
18+
4. Open its detail page and save the command you normally use to start it.
19+
5. Run the command and check its output under **Prozesse**.
20+
21+
Workspaces can be configured later. They are optional and mainly useful once several related projects have been added.
22+
23+
## Running onboarding again
24+
25+
Open **Einstellungen** and select the option to restart onboarding. This does not delete projects or reset settings.

docs/pages/processes.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Processes
2+
3+
![Processes and live logs](../screenshots/processes.png)
4+
5+
The process page shows commands that were started from projects or workspaces.
6+
7+
## Process states
8+
9+
| State | Meaning |
10+
|---|---|
11+
| Running | The command is still active |
12+
| Successful | The command exited with code `0` |
13+
| Failed | The command exited with a non-zero code or could not be started |
14+
| Stopped | The command was stopped from Code Deck |
15+
16+
## What each entry shows
17+
18+
A process entry can contain:
19+
20+
- project name
21+
- command label and command text
22+
- start time
23+
- process ID when available
24+
- stdout and stderr output
25+
- exit code
26+
- stop button for active commands
27+
28+
## Stopping a command
29+
30+
Use **Stop** on the active process. Code Deck asks the operating system to terminate the process and updates the state afterwards.
31+
32+
Some commands start child processes of their own. If a development server remains active after stopping, check the terminal output and the operating system's process list.
33+
34+
## History
35+
36+
Finished entries remain available so recent output can be checked. Removing an entry from the history does not remove the saved project command and does not change project files.
37+
38+
## Common uses
39+
40+
- checking why a development server failed
41+
- following test output
42+
- stopping a long-running command
43+
- seeing which workspace services are still active

docs/pages/project-details.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Project Details
2+
3+
![Project details](../screenshots/project-details.png)
4+
5+
Open **Details** on a project card. This page contains everything that belongs to one project.
6+
7+
## Project information
8+
9+
You can edit:
10+
11+
- display name
12+
- description
13+
- tags
14+
- favorite state
15+
- preferred IDE
16+
- archive state
17+
18+
The path identifies the local directory and is used as the default working directory for commands.
19+
20+
## Quick actions
21+
22+
| Action | What it does |
23+
|---|---|
24+
| **Open in …** | Opens the project with its preferred IDE |
25+
| **Terminal öffnen** | Opens a terminal in the project folder |
26+
| **Ordner öffnen** | Opens Explorer, Finder or the Linux file manager |
27+
| **Status aktualisieren** | Re-reads frameworks, scripts, Docker files and Git information |
28+
| Archive | Hides the project from the normal dashboard without deleting its folder |
29+
| Remove | Removes the project from Code Deck after confirmation; source files remain untouched |
30+
31+
## Commands
32+
33+
Commands are reusable actions such as:
34+
35+
```text
36+
pnpm dev
37+
pnpm test
38+
mvn spring-boot:run
39+
cargo run
40+
docker compose up
41+
```
42+
43+
Each command can have:
44+
45+
- a label shown in the interface
46+
- the actual shell command
47+
- an optional working directory relative to the project
48+
- optional environment variables
49+
- a display order
50+
51+
Starting a command opens a process entry where the output can be followed. A command is never run merely because it was imported or detected.
52+
53+
## Detected package scripts
54+
55+
For projects with `package.json`, Code Deck can show scripts from the `scripts` section. A suggestion is not yet a saved command. Save it when you want it to appear as a regular project action.
56+
57+
## Git information
58+
59+
For Git repositories, the page can show:
60+
61+
- current branch
62+
- number of changed files
63+
- latest commit hash, message and date
64+
65+
Use **Status aktualisieren** after changing branches or making commits outside Code Deck.
66+
67+
## When to use this page
68+
69+
Use the detail page when a project needs more than the single quick action shown on its dashboard card. It is also the correct place to fix a wrong IDE assignment, edit tags or add a new command.

0 commit comments

Comments
 (0)