Skip to content

Commit a674cc1

Browse files
authored
docs: bring back docgen requirements & delete the roadmap (ChrisTitusTech#1153)
1 parent 1652875 commit a674cc1

File tree

4 files changed

+61
-29
lines changed

4 files changed

+61
-29
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ https://github.com/ChrisTitusTech/linutil/blob/main/.github/CONTRIBUTING.md
3232
- [ ] My code adheres to the coding and style guidelines of the project.
3333
- [ ] I have performed a self-review of my own code.
3434
- [ ] I have commented my code, particularly in hard-to-understand areas.
35-
- [ ] I have made corresponding changes to the documentation.
35+
- [ ] I have made corresponding changes to the documentation (`cargo xtask docgen`).
3636
- [ ] My changes generate no errors/warnings/merge conflicts.

.github/workflows/xtask.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: XTask Checks
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "xtask"
7+
- "Cargo.toml"
8+
- "Cargo.lock"
9+
- ".cargo"
10+
- "core/tabs"
11+
- "docs"
12+
push:
13+
paths:
14+
- "xtask"
15+
- "Cargo.toml"
16+
- "Cargo.lock"
17+
- ".cargo"
18+
- "core/tabs"
19+
- "docs"
20+
21+
env:
22+
CARGO_TERM_COLOR: always
23+
24+
jobs:
25+
docgen:
26+
name: DocGen
27+
runs-on: ubuntu-latest
28+
29+
steps:
30+
- name: Checkout sources
31+
uses: actions/checkout@v5
32+
33+
- name: Install Rust
34+
uses: dtolnay/rust-toolchain@stable
35+
36+
- name: Cache Cargo registry
37+
uses: actions/cache@v4
38+
with:
39+
path: ~/.cargo/registry
40+
key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
41+
restore-keys: ${{ runner.os }}-cargo-registry-
42+
43+
- name: Cache Cargo index
44+
uses: actions/cache@v4
45+
with:
46+
path: ~/.cargo/git
47+
key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
48+
restore-keys: ${{ runner.os }}-cargo-index-
49+
50+
- name: Run cargo xtask docgen
51+
run: cargo xtask docgen
52+
53+
- name: Check uncommitted documentation changes
54+
run: |
55+
if [[ -n $(git status --porcelain docs) ]]; then
56+
echo "Please run 'cargo xtask docgen' and commit the changes.";
57+
git --no-pager diff docs/generated;
58+
exit 1;
59+
fi

docs/roadmap.md

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

docs/userguide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ https://github.com/AdnanHodzic/auto-cpufreq
5656
- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash
5757
- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux. Bottles also provides tools to categorize, organize and optimize your applications.
5858
- **Docker**: Docker is an open platform that uses OS-level virtualization to deliver software in packages called containers.
59+
- **Ghostty**: Ghostty is a terminal emulator that has embedded web technologies, allowing for a highly customizable and visually appealing terminal experience.
5960
- **Podman**: Podman is a daemon-less open platform that uses OS-level virtualization to deliver software in packages called containers.
6061
- **Podman-compose**: Podman Compose is a tool for defining and running multi-container applications using Podman.
6162
- **DWM-Titus**: DWM is a dynamic window manager for X.

0 commit comments

Comments
 (0)