Skip to content

Commit b4b2c43

Browse files
authored
Feat/docs (#3)
* feat: docs * fix: docs * feat: docs * fix: permission * fix: docs * fix: docs * fix: code setup
1 parent 86fd0be commit b4b2c43

File tree

13 files changed

+189
-17
lines changed

13 files changed

+189
-17
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- feat/docs # Or your default branch
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
steps:
14+
- uses: actions/checkout@v4
15+
- name: Set up Python
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: '3.x'
19+
- name: Install dependencies
20+
run: |
21+
pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin pymdown-extensions mkdocs-static-i18n
22+
- name: Deploy to GitHub Pages
23+
run: |
24+
mkdocs gh-deploy --force --clean

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,5 @@ pylintrc
7272
.ruff_cache
7373

7474

75-
test.py
75+
test.py
76+
site

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,11 @@ A powerful automation agent for macOS that enables natural language control of v
2525

2626
## Installation & Usage
2727

28-
Please refer to the [Installation Guide](docs/index.md) for detailed instructions on how to install and configure the MacOS Agent.
28+
Please refer to the [Installation Guide](https://computer-use-agents.github.io/MacOS-Agent/#installation) for detailed instructions on how to install and configure the MacOS Agent.
2929

3030
## Contributing
3131

32-
We welcome contributions! Please follow these steps:
33-
34-
1. Fork the repository
35-
2. Create a feature branch
36-
3. Commit your changes
37-
4. Push to the branch
38-
5. Create a Pull Request
32+
Follow the instructions for [development guidelines](https://computer-use-agents.github.io/MacOS-Agent/#development-setup).
3933

4034
## Troubleshooting
4135

docs/_config.yml

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

docs/assets/acc_tree1.png

303 KB
Loading

docs/assets/acc_tree2.png

262 KB
Loading

docs/assets/acc_tree3.png

268 KB
Loading

docs/assets/elon.mp4

14.1 MB
Binary file not shown.

docs/assets/main_page1.png

403 KB
Loading

docs/assets/trump.png

1.08 MB
Loading

0 commit comments

Comments
 (0)