Skip to content

Commit 736f4cf

Browse files
committed
Add docs
1 parent bff2089 commit 736f4cf

File tree

14 files changed

+2253
-97
lines changed

14 files changed

+2253
-97
lines changed

.github/workflows/docs.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/docs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
jobs:
18+
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/configure-pages@v5
25+
- uses: actions/checkout@v5
26+
- uses: actions/setup-python@v5
27+
with:
28+
python-version: 3.x
29+
- run: pip install zensical
30+
- run: |
31+
cd docs
32+
zensical build --clean
33+
- uses: actions/upload-pages-artifact@v4
34+
with:
35+
path: docs/site
36+
- uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@ user.toml
44

55
Session.vim
66
.DS_Store
7+
8+
# Zensical build output
9+
/docs/site

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,38 @@ Pronounced `gʉːt`.
44

55
[![](https://divvun-tc.thetc.se/api/github/v1/repository/divvun/gut/main/badge.svg)](https://divvun-tc.thetc.se/api/github/v1/repository/divvun/gut/main/latest)
66

7-
This is a Git(Hub) multirepo maintenance tool, designed specifically for Divvun. But it should be quite useful to others needing to maintain tens (or hundreds) of similarly structured github repositories.
7+
This is a Git(Hub) multirepo maintenance tool, designed specifically for Divvun. But it should be quite useful to others needing to maintain tens (or hundreds) of similarly structured GitHub repositories.
88

99
Using the `gut apply -s <script>` command, one can in practice run any git command on all repos (or a suitable subset, regex-selected on the repo names), not only the commands directly provided by `gut`.
1010

1111
We think it's pretty cool.
1212

13+
## Documentation
14+
15+
**📚 [Full Documentation](docs/)** - Complete guides and references
16+
17+
Quick links:
18+
- [Get Started](docs/docs/get-started.md) - Installation and setup
19+
- [Common Commands](docs/docs/usage/common-commands.md) - Most frequently used commands
20+
- [Command Overview](docs/docs/usage/overview.md) - All available commands
21+
- [Architecture](docs/docs/architecture.md) - Technical details
22+
- [Contributing](docs/docs/contributing.md) - Development guide
23+
24+
### Viewing Documentation Locally
25+
26+
The documentation is built with [Zensical](https://zensical.org/). To view it locally:
27+
28+
```bash
29+
# Install Zensical
30+
pip install zensical
31+
32+
# Serve documentation
33+
cd docs
34+
zensical serve
35+
```
36+
37+
Then open http://localhost:8000 in your browser.
38+
1339

1440
## Installation
1541

doc/template/delta.toml

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

doc/template/template.md

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

doc/template/template.toml

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

docs/.github/workflows/docs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
jobs:
12+
deploy:
13+
environment:
14+
name: github-pages
15+
url: ${{ steps.deployment.outputs.page_url }}
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/configure-pages@v5
19+
- uses: actions/checkout@v5
20+
- uses: actions/setup-python@v5
21+
with:
22+
python-version: 3.x
23+
- run: pip install zensical
24+
- run: zensical build --clean
25+
- uses: actions/upload-pages-artifact@v4
26+
with:
27+
path: site
28+
- uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)