Skip to content

Commit e1a1058

Browse files
committed
feat: scaffold the new documentation for Databús
1 parent f06575d commit e1a1058

21 files changed

Lines changed: 566 additions & 0 deletions

.github/workflows/docs.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Databús Documentation
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- docs
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+
defaults:
18+
run:
19+
working-directory: docs
20+
steps:
21+
- uses: actions/configure-pages@v6
22+
- uses: actions/checkout@v6
23+
- uses: actions/setup-python@v6
24+
with:
25+
python-version: 3.x
26+
- run: pip install zensical mkdocstrings[python]
27+
- run: zensical build --clean
28+
- uses: actions/upload-pages-artifact@v5
29+
with:
30+
path: docs/site
31+
- uses: actions/deploy-pages@v5
32+
id: deployment

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ publisher/feed/files/*.pb
88
publisher/feed/files/*.json
99
gtfs/
1010

11+
# Zensical
12+
site/
13+
1114
# Ubuntu server
1215
restart_services.sh
1316

docs/.python-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.14

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Databús Documentation
2+
3+
This is the documentation for the Databús platform.

docs/content/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
icon: lucide/map-pin
3+
---
4+
5+
# Overview
6+
7+
Databús is a platform for managing and publishing GTFS data.
8+
9+
!!! warning "Work in Progress"
10+
11+
Both Databús and its documentation are currently under active development. Estimated release date is August 2026.

docs/content/sections.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
icon: lucide/files
3+
---
4+
5+
# Sections
6+
7+
These are the future sections of the documentation.
8+
9+
1. Conceptual Overview
10+
2. Architecture
11+
3. Processes
12+
4. Data Model
13+
5. Operations
14+
6. Interfaces

docs/main.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
def main():
2+
print("Hello from docs!")
3+
4+
5+
if __name__ == "__main__":
6+
main()
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)