Skip to content

Commit df162c6

Browse files
committed
Restructure master branch for content only
- Moved content from docs/ to root level (like modules/specs repos) - Renamed index.md files to README.md for GitHub UI navigation - Removed build infrastructure (now on site branch) - Added sync-to-site.yml workflow to trigger deploys Structure: README.md - docs homepage ecosystem/ - ecosystem docs setup/ - setup guides .github/workflows/ - sync workflow only
1 parent f9a8966 commit df162c6

26 files changed

Lines changed: 35 additions & 1600 deletions

.github/workflows/deploy.yml

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

.github/workflows/sync-to-site.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Trigger Deploy on Master Push
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
workflow_dispatch:
8+
9+
permissions:
10+
actions: write
11+
contents: read
12+
13+
jobs:
14+
trigger-deploy:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
20+
- name: Trigger deploy workflow
21+
run: |
22+
gh workflow run deploy.yml --ref site
23+
env:
24+
GH_TOKEN: ${{ github.token }}

.gitignore

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,3 @@
1-
# Build artifacts
2-
site/
3-
4-
# Python virtual environment
5-
.venv/
6-
venv/
7-
env/
8-
9-
# Python cache
10-
__pycache__/
11-
*.py[cod]
12-
*$py.class
13-
14-
# Cloned repositories (fetched during build)
15-
specs-repo/
16-
modules-repo/
17-
18-
# Copied content from cloned repos (fetched during build)
19-
docs/modules/
20-
docs/specification/
21-
221
# IDE
232
.vscode/
243
.idea/

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,16 @@
1-
# MICRORACK Documentation
1+
# About MICRORACK
22

3-
Official documentation for the MICRORACK modular synthesizer system.
3+
MICRORACK is a compact, affordable modular synthesizer system designed for learners, makers, and performers. This site holds the documentation, Specifications, and how-tos you need to build, patch, and integrate MICRORACK.
44

5-
## Overview
5+
## Start Here
66

7-
MICRORACK is a compact, affordable modular synthesizer system designed for learners, makers, and performers. This site provides everything you need to build, patch, and integrate MICRORACK modules.
7+
- [Setup](index.md) — setup and first patches
8+
- [Ecosystem](ecosystem/index.md) — power, I/O, and system connectivity
9+
- [Modules](modules/index.md) — module overviews and specs
10+
- [Specification](specification/index.md) — mechanical and electrical specifications
811

9-
Visit the live documentation at: **[docs.microrack.org](https://docs.microrack.org)**
12+
## Support
1013

11-
## What's Inside
12-
13-
- **🚀 Setup**: Getting started guides and first patches.
14-
- **🔗 Ecosystem**: Detailed information on power, I/O, chassis, and system connectivity.
15-
- **⊞ Modules**: Comprehensive overviews and technical details for all MICRORACK modules.
16-
- **📐 Specification**: Official mechanical and electrical standards for the platform.
17-
18-
## Project Structure
19-
20-
This site is built using [MkDocs](https://www.mkdocs.org/) with the [Material theme](https://squidfunk.github.io/mkdocs-material/). It dynamically aggregates content from multiple MICRORACK repositories to ensure the documentation is always up-to-date with the latest module designs and specifications.
21-
22-
- **Modules**: Sourced from [microrack/modules-test](https://github.com/microrack/modules-test)
23-
- **Specifications**: Sourced from [microrack/specs-test](https://github.com/microrack/specs-test)
24-
25-
## Contributing
26-
27-
If you find errors or have suggestions for improvement, please open an issue or a pull request in the respective repository.
28-
29-
---
30-
© 2019-2025 MICRORACK | [microrack.org](https://microrack.org)
14+
- FAQ: [microrack.org/faq](https://microrack.org/faq)
15+
- Community: [Instagram](https://instagram.com/microrack)
16+
- Help: [support@microrack.org](mailto:support@microrack.org)

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)