Skip to content

Commit 46dfcc8

Browse files
committed
Give the docs folder a more polished layout
Add a docs index page with a card layout, give each reference doc an icon title, a navigation row, and a tagline, and turn key notes and warnings into GitHub callouts. Section headings are unchanged so existing anchor links keep working. release-notes.md is left as is because it becomes the GitHub release text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BUhabxL4SPejg19jgbSyYN
1 parent e6a79bd commit 46dfcc8

10 files changed

Lines changed: 156 additions & 37 deletions

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ Open `http://127.0.0.1:4173` for a browser preview with sample data. Desktop ope
172172
| | |
173173
| ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
174174
| 📖 **[Wiki: how to use Command Center](https://github.com/Commanderx-code/command-center/wiki)** | A step-by-step guide to every page and feature, plus troubleshooting. |
175+
| 📚 **[Documentation index](docs/README.md)** | Every reference doc in one place. |
175176
| 📥 [Installation](docs/installation.md) | Packages, requirements, checksums, and source builds. |
176177
| 🧭 [User guide](docs/user-guide.md) | Features, integrations, command behavior, and local data. |
177178
| 🧑‍💻 [Development](docs/development.md) | Repository layout, checks, and Toolbox updates. |

‎docs/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<div align="center">
2+
3+
<img src="../src-tauri/icons/command-center.svg" alt="Command Center icon" width="72" />
4+
5+
# Command Center documentation
6+
7+
Reference docs for installing, using, and developing Command Center.<br />
8+
Looking for a step-by-step walkthrough? Read the **[📖 Wiki guide](https://github.com/Commanderx-code/command-center/wiki)**.
9+
10+
<sub>[🏠 Back to the README](../README.md)</sub>
11+
12+
</div>
13+
14+
## 👤 Using Command Center
15+
16+
<table>
17+
<tr>
18+
<td width="50%" valign="top">
19+
<h3>📦 <a href="installation.md">Installation</a></h3>
20+
Release packages, requirements, checksum and provenance verification, and building from source.
21+
</td>
22+
<td width="50%" valign="top">
23+
<h3>🧭 <a href="user-guide.md">User guide</a></h3>
24+
Features, connecting your setup, how commands run, local data, and every page in detail.
25+
</td>
26+
</tr>
27+
<tr>
28+
<td width="50%" valign="top">
29+
<h3>🔁 <a href="operations.md">Workflows and profiles</a></h3>
30+
Maintenance recipes, machine profiles, personal Toolbox folders, recovery tests, and notifications.
31+
</td>
32+
<td width="50%" valign="top">
33+
<h3>🚚 <a href="setup-and-workspaces.md">Setup and workspaces</a></h3>
34+
Setup bundles between machines, the first-run wizard, project workspaces, and keyboard navigation.
35+
</td>
36+
</tr>
37+
</table>
38+
39+
## 🛠️ Building and releasing
40+
41+
<table>
42+
<tr>
43+
<td width="50%" valign="top">
44+
<h3>🛠️ <a href="development.md">Development</a></h3>
45+
Architecture, local checks, updating Commander Toolbox, packaging, the wiki, and screenshots.
46+
</td>
47+
<td width="50%" valign="top">
48+
<h3>🚀 <a href="releases.md">Releases and updates</a></h3>
49+
Source updates and rollback, preparing a release, packaging CI, and the AUR package.
50+
</td>
51+
</tr>
52+
</table>
53+
54+
## 🗂️ Also in this folder
55+
56+
| Path | What it is |
57+
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
58+
| 📝 [`release-notes.md`](release-notes.md) | Notes for the current release. `npm run release:draft` uses them as the GitHub release text. |
59+
| 📖 [`wiki/`](wiki/) | Source of the [GitHub wiki](https://github.com/Commanderx-code/command-center/wiki), published by the `Publish wiki` workflow. |
60+
| 🖼️ [`images/`](images/) | Screenshots used by the README and wiki. |
61+
| 🗄️ [`history/`](history/) | Historical development notes. They describe earlier versions and may no longer match the app. |
62+
63+
<div align="center">
64+
<br />
65+
<sub>See also: <a href="../CHANGELOG.md">📝 Changelog</a> · <a href="../CONTRIBUTING.md">🤝 Contributing</a> · <a href="../SECURITY.md">🔐 Security</a> · <a href="../THIRD_PARTY.md">🧾 Third-party notices</a></sub>
66+
</div>

‎docs/development.md‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Development
1+
# 🛠️ Development
22

3-
[← Command Center](../README.md) · [Installation](installation.md) · [Contributing](../CONTRIBUTING.md)
3+
<sub>[🏠 README](../README.md) &nbsp;·&nbsp; [📚 Docs](README.md) &nbsp;·&nbsp; [📦 Installation](installation.md) &nbsp;·&nbsp; [🤝 Contributing](../CONTRIBUTING.md)</sub>
4+
5+
> _Architecture, checks, Toolbox updates, packaging, and docs._
46
57
## Architecture
68

@@ -39,7 +41,8 @@ The **Security audit** workflow runs `cargo audit --file src-tauri/Cargo.lock` a
3941

4042
Workflow actions are pinned to full commit SHAs, with the version in a trailing comment. Dependabot (`.github/dependabot.yml`) opens grouped weekly updates for Actions, npm, and Cargo; review an Action update's release before merging it. The Commander Toolbox pin is excluded; update it with `scripts/pin-toolbox.mjs`.
4143

42-
Tests do not push real repositories, run personal backups, activate Home Manager, or execute real Toolbox installers. UI changes should also be checked visually in the browser preview and, for native behavior, in the desktop app.
44+
> [!NOTE]
45+
> Tests do not push real repositories, run personal backups, activate Home Manager, or execute real Toolbox installers. UI changes should also be checked visually in the browser preview and, for native behavior, in the desktop app.
4346
4447
## Updating Commander Toolbox
4548

@@ -61,11 +64,17 @@ npm run desktop:package
6164

6265
Tauri writes `.deb` and `.rpm` packages under `src-tauri/target/release/bundle/`. Keep versions aligned in `package.json`, `package-lock.json`, `src-tauri/Cargo.toml`, `src-tauri/Cargo.lock`, and `src-tauri/tauri.conf.json` when preparing a version bump.
6366

64-
Release packages come from CI, which builds on Ubuntu 22.04 and declares a glibc 2.35 floor. A local `desktop:package` build on a newer distribution links against its newer glibc, so `scripts/verify-packages.py` correctly rejects it as a release candidate. See [Releases](releases.md#package-validation-and-distribution-ci).
67+
> [!IMPORTANT]
68+
> Release packages come from CI, which builds on Ubuntu 22.04 and declares a glibc 2.35 floor. A local `desktop:package` build on a newer distribution links against its newer glibc, so `scripts/verify-packages.py` correctly rejects it as a release candidate. See [Releases](releases.md#package-validation-and-distribution-ci).
6569
6670
## Wiki
6771

68-
The [GitHub wiki](https://github.com/Commanderx-code/command-center/wiki) is published from `docs/wiki/`. Edit the pages there and open a pull request; after it merges, the `Publish wiki` workflow copies them to the wiki. Edits made directly in the wiki are overwritten the next time that page changes here. Page links use wiki names such as `[Settings](Settings)`, so they only resolve on the wiki itself. `Home.md`, `_Sidebar.md`, and `_Footer.md` are the landing page, sidebar, and footer.
72+
The [GitHub wiki](https://github.com/Commanderx-code/command-center/wiki) is published from `docs/wiki/`. Edit the pages there and open a pull request; after it merges, the `Publish wiki` workflow copies them to the wiki.
73+
74+
> [!WARNING]
75+
> Edits made directly in the wiki are overwritten the next time that page changes here.
76+
77+
Page links use wiki names such as `[Settings](Settings)`, so they only resolve on the wiki itself. `Home.md`, `_Sidebar.md`, and `_Footer.md` are the landing page, sidebar, and footer.
6978

7079
## Documentation screenshots
7180

‎docs/history/SETTINGS-UPDATE.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
> Historical development notes. These describe an earlier version and may no longer match the app. See the [current user guide](../user-guide.md) for supported behavior.
1+
> [!WARNING]
2+
> **Historical development notes.** These describe an earlier version and may no longer match the app. See the [current user guide](../user-guide.md) for supported behavior.
23
34
# Basic settings update
45

‎docs/history/UI-POLISH.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
> Historical development notes. These describe an earlier version and may no longer match the app. See the [current user guide](../user-guide.md) for supported behavior.
1+
> [!WARNING]
2+
> **Historical development notes.** These describe an earlier version and may no longer match the app. See the [current user guide](../user-guide.md) for supported behavior.
23
34
# Settings and UI polish
45

@@ -7,6 +8,7 @@ Existing settings are migrated through defaults; editor, terminal, and scan
78
folder choices are retained.
89

910
New preferences in Settings:
11+
1012
- Theme: Dark, Light, or System (follows desktop color scheme).
1113
- Text size: Standard or Larger.
1214
- Repository layout: Cards or List.
@@ -26,6 +28,7 @@ Search shortcut: Ctrl+K (Cmd+K in a browser on macOS); Escape clears search.
2628
Errors remain visible until dismissed or replaced by a later notification.
2729

2830
Validation:
31+
2932
- `node --test tests/*.test.mjs` — preferences migration, normalization,
3033
simultaneous status badges, error-state filtering, and stable sorting.
3134
- `npm run check` and `npm run build`.

‎docs/installation.md‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# Installation
1+
# 📦 Installation
22

3-
[← Command Center](../README.md) · [User guide](user-guide.md) · [Development](development.md)
3+
<sub>[🏠 README](../README.md) &nbsp;·&nbsp; [📚 Docs](README.md) &nbsp;·&nbsp; [🧭 User guide](user-guide.md) &nbsp;·&nbsp; [🛠️ Development](development.md)</sub>
4+
5+
> _Release packages, verification, and building from source._
46
57
## Release packages
68

79
Download a package and `SHA256SUMS` from the [GitHub releases page](https://github.com/Commanderx-code/command-center/releases/latest).
810

9-
Packages target **Linux x86_64 / amd64** and require **GTK 3, WebKitGTK 4.1, and glibc 2.35 or newer** from 0.6.0 (0.5.x packages require glibc 2.39). Packages declare these dependencies. Both packages are built once on Ubuntu 22.04, then installed and launched on Ubuntu 22.04, Debian 12, Ubuntu 24.04, and Fedora 43. See the release notes for the workflow run. ARM, Windows, and macOS packages are not currently published.
11+
> [!IMPORTANT]
12+
> Packages target **Linux x86_64 / amd64** and require **GTK 3, WebKitGTK 4.1, and glibc 2.35 or newer** from 0.6.0 (0.5.x packages require glibc 2.39). Packages declare these dependencies. Both packages are built once on Ubuntu 22.04, then installed and launched on Ubuntu 22.04, Debian 12, Ubuntu 24.04, and Fedora 43. See the release notes for the workflow run. ARM, Windows, and macOS packages are not currently published.
1013
1114
To verify a downloaded package, put it and `SHA256SUMS` in the same directory and run:
1215

@@ -42,9 +45,13 @@ On Arch or an Arch-based system such as Garuda (0.6.0 and later):
4245
sudo pacman -U ./command-center-0.7.1-1-x86_64.pkg.tar.zst
4346
```
4447

45-
The Arch package is built from the release tag with `packaging/aur/PKGBUILD` in a clean Arch container and tracks current Arch libraries; update your system before installing it. To build it yourself instead, run `makepkg -si` from a copy of `packaging/aur/`.
48+
> [!TIP]
49+
> The Arch package is built from the release tag with `packaging/aur/PKGBUILD` in a clean Arch container and tracks current Arch libraries; update your system before installing it. To build it yourself instead, run `makepkg -si` from a copy of `packaging/aur/`.
50+
51+
Launch **Command Center** from your application menu.
4652

47-
Launch **Command Center** from your application menu. Run the app as your normal user, without `sudo`.
53+
> [!WARNING]
54+
> Run the app as your normal user, without `sudo`.
4855
4956
## From source on Arch/Garuda
5057

@@ -88,12 +95,14 @@ The per-user installer writes `~/.local/bin/command-center`, an icon, and a desk
8895
| `npm run desktop:install` | Release executable and per-user application-menu entry. |
8996
| `npm run desktop:package` | `.deb` and `.rpm` files in `src-tauri/target/release/bundle/`. |
9097

91-
The browser preview uses sample repositories and configurations. It cannot run Git operations, access backups, launch applications, or save real configuration files. Source changes rebuild automatically; refresh the browser to load them.
98+
> [!NOTE]
99+
> The browser preview uses sample repositories and configurations. It cannot run Git operations, access backups, launch applications, or save real configuration files. Source changes rebuild automatically; refresh the browser to load them.
92100
93101
## Connect integrations
94102

95103
After installation, open **Settings → System integrations**. Command Center can detect an existing dotfiles machine configuration, backup helpers, and Ghostty/Fastfetch source paths. Review the detected paths and save your settings.
96104

97105
Git, Home Manager, Restic, Ghostty, Fastfetch, and backup helpers are used when installed and configured. They are not all required to open the app. See the [user guide](user-guide.md#connect-your-setup) for each integration.
98106

99-
File restores require **Restic 0.17 or newer** for its no-overwrite protection; Command Center checks support before preparing a restore. Some distributions ship an older Restic independently of Command Center.
107+
> [!NOTE]
108+
> File restores require **Restic 0.17 or newer** for its no-overwrite protection; Command Center checks support before preparing a restore. Some distributions ship an older Restic independently of Command Center.

‎docs/operations.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Workflows, profiles, and recovery verification
1+
# 🔁 Workflows, profiles, and recovery verification
22

3-
[← Command Center](../README.md) · [User guide](user-guide.md)
3+
<sub>[🏠 README](../README.md) &nbsp;·&nbsp; [📚 Docs](README.md) &nbsp;·&nbsp; [🧭 User guide](user-guide.md)</sub>
4+
5+
> _Maintenance recipes, machine profiles, personal tools, recovery tests, and notifications._
46
57
## Maintenance workflows
68

@@ -16,7 +18,12 @@ The weekly maintenance example checks local backup-drive readiness, runs the per
1618

1719
A machine profile is a named, ordered setup recipe for a workstation, laptop, or new install. Add repository clones, Toolbox installers, configuration operations, and other steps through the same editor. Set a profile-specific dotfiles checkout and Home Manager flake profile, or leave them blank to use Settings. These overrides apply only to that profile's reviewed commands.
1820

19-
**Review profile** shows whether each command can be prepared on the current machine. Optional path checks show **Present · inspect before skipping** when a file or directory exists. Presence does not establish that the right version or content is installed. **Skip inspected step** requires confirmation. Missing prerequisites can be satisfied by earlier steps; the app rechecks each command immediately before execution.
21+
**Review profile** shows whether each command can be prepared on the current machine. Optional path checks show **Present · inspect before skipping** when a file or directory exists.
22+
23+
> [!CAUTION]
24+
> Presence does not establish that the right version or content is installed.
25+
26+
**Skip inspected step** requires confirmation. Missing prerequisites can be satisfied by earlier steps; the app rechecks each command immediately before execution.
2027

2128
Profiles operate on the local computer. They do not connect to remote machines, automatically replace configuration files, or bypass Toolbox installer prompts. Clone destinations must be new directories. Recipes and personal tools live in `operations.json`. In 0.5.0, [setup bundles](setup-and-workspaces.md) include them; preference-only Settings exports still do not.
2229

@@ -44,7 +51,10 @@ The prerequisite field checks whether the executable is available. It does not i
4451

4552
The test uses `restic dump` to restore the selected file into a temporary directory, compares its SHA-256 against the saved baseline, and removes its temporary copy on normal completion. It never overwrites the original. A mismatch or missing file fails visibly in Activity. Abrupt process termination or power loss can leave a temporary copy for normal system temporary-file cleanup.
4653

47-
Recent recovery results include the baseline ID, result, and timestamp. The baseline selector maps IDs to recorded files and dates. Results follow Activity's 100-job retention. Success proves recovery of that selected file from that snapshot using the current credentials; it does not certify all snapshots, all files, or a bootable system restore. A file changed after recording may legitimately mismatch another snapshot.
54+
Recent recovery results include the baseline ID, result, and timestamp. The baseline selector maps IDs to recorded files and dates. Results follow Activity's 100-job retention.
55+
56+
> [!NOTE]
57+
> Success proves recovery of that selected file from that snapshot using the current credentials; it does not certify all snapshots, all files, or a bootable system restore. A file changed after recording may legitimately mismatch another snapshot.
4858
4959
## Change timeline
5060

0 commit comments

Comments
 (0)