Skip to content

Commit 0ac5297

Browse files
Source Roboticsclaude
Source Robotics
and
claude
committed
Landing page of docs.source-robotics.com: one card per product
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
0 parents  commit 0ac5297

11 files changed

Lines changed: 707 additions & 0 deletions

File tree

‎.github/workflows/pages.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Builds the landing page and publishes it with GitHub Pages on every push to main.
2+
# In the repository's Settings > Pages, the source must be "GitHub Actions" and the custom domain
3+
# docs.source-robotics.com (with this source no CNAME file is needed).
4+
name: pages
5+
6+
on:
7+
push:
8+
branches: [main]
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: "3.11"
28+
cache: pip
29+
- run: pip install -r requirements.txt
30+
- run: mkdocs build --strict
31+
- uses: actions/upload-pages-artifact@v3
32+
with:
33+
path: site
34+
35+
deploy:
36+
needs: build
37+
runs-on: ubuntu-latest
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
steps:
42+
- id: deployment
43+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# build output
2+
site/
3+
.cache/
4+
5+
# local environments
6+
.venv/
7+
venv/
8+
__pycache__/
9+
10+
# editors / OS
11+
.vscode/
12+
.DS_Store

‎LICENSE‎

Lines changed: 428 additions & 0 deletions
Large diffs are not rendered by default.

‎LICENSE-CODE‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This license applies to the code in this repository: the site's configuration, stylesheets and workflows.
2+
The text and the images are licensed under CC BY-SA 4.0, see LICENSE.
3+
4+
MIT License
5+
6+
Copyright (c) 2026 Source Robotics d.o.o.
7+
8+
Permission is hereby granted, free of charge, to any person obtaining a copy
9+
of this software and associated documentation files (the "Software"), to deal
10+
in the Software without restriction, including without limitation the rights
11+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
copies of the Software, and to permit persons to whom the Software is
13+
furnished to do so, subject to the following conditions:
14+
15+
The above copyright notice and this permission notice shall be included in all
16+
copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24+
SOFTWARE.

‎README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Source Robotics documentation
2+
3+
The landing page of [docs.source-robotics.com](https://docs.source-robotics.com/): one card per product, each
4+
linking to that product's own documentation site.
5+
6+
## How the domain works
7+
8+
This repository is the organisation's own GitHub Pages site, so its custom domain, `docs.source-robotics.com`, is
9+
also the domain of every other documentation site in the organisation. A docs repository named `par6` is served at
10+
`docs.source-robotics.com/par6/`, `PAROL-docs` at `docs.source-robotics.com/PAROL-docs/`, and so on.
11+
12+
- **Do not rename or delete this repository.** Every Source Robotics docs site would move back to its github.io
13+
address.
14+
- **Renaming a docs repository changes its address,** and links to the old one stop working. A redirect page can be
15+
added here under the old name.
16+
- **A new product** gets a card in `docs/index.md` once its docs repository publishes.
17+
18+
## Preview it locally
19+
20+
```bash
21+
git clone https://github.com/Source-Robotics/source-robotics.github.io.git
22+
cd source-robotics.github.io
23+
python3 -m venv .venv
24+
.venv/bin/pip install -r requirements.txt
25+
.venv/bin/mkdocs serve
26+
```
27+
28+
Open `http://127.0.0.1:8000/`. Every push to `main` builds the site and publishes it.
29+
30+
## License
31+
32+
- **Text and images:** [Creative Commons Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/),
33+
see [LICENSE](LICENSE).
34+
- **Code:** the [MIT license](LICENSE-CODE).
35+
- **Names and logos:** the Source Robotics name, the product names and the logos are not covered by either license.

‎docs/assets/Icon2.png‎

249 KB
Loading

‎docs/assets/logo_new_2.png‎

38.4 KB
Loading

‎docs/index.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
# Source Robotics documentation
8+
9+
Manuals and guides for the open-source robot arms, grippers and motor controllers by
10+
[Source Robotics](https://source-robotics.com). Each product has its own site, with its own search.
11+
12+
## Robot arms
13+
14+
<div class="grid cards" markdown>
15+
16+
- :material-robot-industrial:{ .lg .middle } **PAR6**
17+
18+
---
19+
20+
The collaborative robot arm for education, research and AI: the arm, the Robot Control Box, programming and the
21+
real-time interface.
22+
23+
:material-clock-outline: Coming soon
24+
25+
- :material-robot-industrial-outline:{ .lg .middle } **PAROL6**
26+
27+
---
28+
29+
The 3D-printed desktop robot arm: parts, building, wiring and its software.
30+
31+
[:octicons-arrow-right-24: PAROL6 documentation](https://docs.source-robotics.com/PAROL-docs/)
32+
33+
</div>
34+
35+
## Grippers
36+
37+
<div class="grid cards" markdown>
38+
39+
- :material-hand-back-right-outline:{ .lg .middle } **MSG gripper**
40+
41+
---
42+
43+
A compliant stepper gripper with force feedback and an adjustable grip of up to 200 mm.
44+
45+
[:octicons-arrow-right-24: MSG documentation](https://docs.source-robotics.com/MSG-gripper-docs/)
46+
47+
- :material-hand-back-left-outline:{ .lg .middle } **SSG-48 gripper**
48+
49+
---
50+
51+
An adaptive electric gripper with force feedback.
52+
53+
[:octicons-arrow-right-24: SSG-48 documentation](https://docs.source-robotics.com/SSG48-gripper-docs/)
54+
55+
</div>
56+
57+
## Motor controllers
58+
59+
<div class="grid cards" markdown>
60+
61+
- :material-chip:{ .lg .middle } **STEPFOC**
62+
63+
---
64+
65+
Field-oriented control for stepper motors, which turns them into servo motors.
66+
67+
[:octicons-arrow-right-24: STEPFOC documentation](https://docs.source-robotics.com/STEPFOC-docs/)
68+
69+
- :material-chip:{ .lg .middle } **Spectral micro BLDC**
70+
71+
---
72+
73+
A compact field-oriented controller for brushless motors.
74+
75+
[:octicons-arrow-right-24: Spectral BLDC documentation](https://docs.source-robotics.com/Spectral-BLDC-docs/)
76+
77+
</div>
78+
79+
## Help and source code
80+
81+
- **Questions and discussion:** the [Source Robotics Discord](https://discord.gg/prjUvjmGpZ).
82+
- **A mistake in a manual:** every page has a link to edit it or to report the problem on GitHub.
83+
- **Hardware designs, firmware and software:** [github.com/Source-Robotics](https://github.com/Source-Robotics).

‎docs/stylesheets/extra.css‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/* Source Robotics docs landing page — the same header as the product sites */
2+
3+
.md-header__button.md-logo img {
4+
height: 48px;
5+
width: auto;
6+
}
7+
8+
/* Product cards: a little more air between the groups */
9+
.md-typeset h2 {
10+
margin-top: 2rem;
11+
}

‎mkdocs.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
site_name: Source Robotics Docs
2+
site_description: Documentation for the open-source robot arms, grippers and motor controllers by Source Robotics.
3+
# This repository is the organisation's own GitHub Pages site. Its custom domain is the domain of EVERY Source Robotics
4+
# documentation site: each docs repository is served at docs.source-robotics.com/<repository name>/.
5+
site_url: https://docs.source-robotics.com/
6+
repo_url: https://github.com/Source-Robotics
7+
repo_name: Source-Robotics
8+
copyright: |
9+
&copy; 2026 <a href="https://source-robotics.com" target="_blank" rel="noopener">Source Robotics d.o.o.</a> ·
10+
Text and images <a href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank" rel="noopener">CC BY-SA 4.0</a> ·
11+
Code <a href="https://github.com/Source-Robotics/source-robotics.github.io/blob/main/LICENSE-CODE" target="_blank" rel="noopener">MIT</a>
12+
13+
theme:
14+
name: material
15+
logo: assets/logo_new_2.png
16+
favicon: assets/Icon2.png
17+
language: en
18+
font:
19+
text: Roboto
20+
code: Roboto Mono
21+
icon:
22+
repo: fontawesome/brands/github
23+
palette: # the same as the PAR6 docs
24+
- scheme: slate
25+
primary: black
26+
accent: green
27+
toggle:
28+
icon: material/weather-night
29+
name: Switch to light mode
30+
- scheme: default
31+
primary: black
32+
accent: green
33+
toggle:
34+
icon: material/weather-sunny
35+
name: Switch to dark mode
36+
37+
# One page: no search box (each product's site has its own search).
38+
plugins: []
39+
40+
markdown_extensions:
41+
- attr_list
42+
- md_in_html
43+
- pymdownx.emoji:
44+
emoji_index: !!python/name:material.extensions.emoji.twemoji
45+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
46+
47+
extra_css:
48+
- stylesheets/extra.css
49+
50+
extra:
51+
social:
52+
- icon: material/web
53+
link: https://source-robotics.com
54+
- icon: fontawesome/brands/github
55+
link: https://github.com/Source-Robotics
56+
- icon: fontawesome/brands/instagram
57+
link: https://www.instagram.com/5arcrnjak/
58+
- icon: fontawesome/brands/x-twitter
59+
link: https://twitter.com/SourceRobotics
60+
- icon: fontawesome/brands/linkedin
61+
link: https://www.linkedin.com/in/petar-crnjak-009b43180/
62+
- icon: fontawesome/brands/discord
63+
link: https://discord.gg/prjUvjmGpZ
64+
- icon: fontawesome/brands/patreon
65+
link: https://www.patreon.com/PCrnjak
66+
67+
nav:
68+
- index.md

0 commit comments

Comments
 (0)