Skip to content

Commit 76183de

Browse files
committed
Added generated docs for laborchestrator and platform-status-db
1 parent 0b66bf5 commit 76183de

File tree

14 files changed

+6227
-0
lines changed

14 files changed

+6227
-0
lines changed

docs/laborchestrator/README.md

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
# Lab Orchestrator Documentation
2+
3+
Welcome to the Lab Orchestrator documentation. This directory contains comprehensive guides for configuring and using Lab Orchestrator in your laboratory automation environment.
4+
5+
## Documentation Structure
6+
7+
This documentation is organized into the following sections:
8+
9+
### 1. [Getting Started](getting-started.md)
10+
- Installation instructions
11+
- Quick start guide
12+
- Command-line interface
13+
- Development commands
14+
- Troubleshooting common installation issues
15+
16+
**Start here if you're new to Lab Orchestrator.**
17+
18+
### 2. [Configuration](configuration.md)
19+
- Lab configuration YAML format
20+
- Device types and parameters
21+
- PythonLab translation mappings
22+
- Orchestrator parameters
23+
- Environment variables
24+
- Best practices for configuration management
25+
26+
**Use this guide to set up your laboratory devices and resources.**
27+
28+
### 3. [Writing Processes](writing-processes.md)
29+
- PythonLab process structure
30+
- Resource types (devices and containers)
31+
- Device operations
32+
- Complete workflow examples
33+
- Best practices for process development
34+
- Troubleshooting process errors
35+
36+
**Learn how to create laboratory workflows using PythonLab.**
37+
38+
### 4. [SiLA Integration](sila-integration.md)
39+
- Starting the SiLA server
40+
- SiLA features and commands
41+
- Client integration examples
42+
- SSL/TLS configuration
43+
- Network discovery
44+
- Security best practices
45+
46+
**Integrate Lab Orchestrator with your laboratory automation system.**
47+
48+
### 5. [API Reference](api-reference.md)
49+
- Orchestrator class reference
50+
- ScheduleManager API
51+
- Data structures (ProcessStep, ContainerInfo, etc.)
52+
- WorkerInterface and WorkerObserver
53+
- Database integration
54+
- Complete code examples
55+
56+
**Detailed reference for developers working with the Lab Orchestrator API.**
57+
58+
### 6. [Deployment](deployment.md)
59+
- Docker deployment (recommended)
60+
- Direct Python deployment
61+
- Systemd service setup
62+
- Kubernetes deployment
63+
- Security considerations
64+
- Monitoring and logging
65+
- Backup and recovery
66+
67+
**Deploy Lab Orchestrator in production environments.**
68+
69+
## Quick Navigation
70+
71+
### Common Tasks
72+
73+
- **Install Lab Orchestrator**: [Getting Started → Installation](getting-started.md#installation)
74+
- **Configure lab devices**: [Configuration → Lab Configuration YAML](configuration.md#lab-configuration-yaml)
75+
- **Write your first process**: [Writing Processes → Examples](writing-processes.md#examples)
76+
- **Start the SiLA server**: [SiLA Integration → Starting the SiLA Server](sila-integration.md#starting-the-sila-server)
77+
- **Deploy with Docker**: [Deployment → Docker Deployment](deployment.md#docker-deployment)
78+
79+
### Reference Materials
80+
81+
- **Device types**: [Configuration → Device Types](configuration.md#device-types)
82+
- **Process methods**: [Writing Processes → Device Operations](writing-processes.md#device-operations)
83+
- **Orchestrator API**: [API Reference → Orchestrator](api-reference.md#orchestrator)
84+
- **Data structures**: [API Reference → Data Structures](api-reference.md#data-structures)
85+
86+
## Documentation Format
87+
88+
All documentation is written in **Markdown** format, making it easy to:
89+
- View directly on GitLab/GitHub
90+
- Integrate with MkDocs
91+
- Convert to other formats (HTML, PDF, etc.)
92+
- Version control alongside code
93+
94+
## Integrating with MkDocs
95+
96+
To integrate this documentation with MkDocs, create a `mkdocs.yml` file in your project root:
97+
98+
```yaml
99+
site_name: Lab Orchestrator Documentation
100+
site_description: Documentation for Lab Orchestrator - Laboratory Workflow Automation
101+
site_author: Your Organization
102+
103+
theme:
104+
name: material
105+
palette:
106+
primary: indigo
107+
accent: blue
108+
features:
109+
- navigation.tabs
110+
- navigation.sections
111+
- toc.integrate
112+
113+
nav:
114+
- Home: new_docs/index.md
115+
- Getting Started: new_docs/getting-started.md
116+
- Configuration: new_docs/configuration.md
117+
- Writing Processes: new_docs/writing-processes.md
118+
- SiLA Integration: new_docs/sila-integration.md
119+
- API Reference: new_docs/api-reference.md
120+
- Deployment: new_docs/deployment.md
121+
122+
markdown_extensions:
123+
- admonition
124+
- codehilite
125+
- toc:
126+
permalink: true
127+
- pymdownx.highlight
128+
- pymdownx.superfences
129+
- pymdownx.tabbed
130+
131+
plugins:
132+
- search
133+
- mkdocstrings
134+
```
135+
136+
Then build and serve the documentation:
137+
138+
```bash
139+
# Install MkDocs
140+
pip install mkdocs mkdocs-material
141+
142+
# Serve locally
143+
mkdocs serve
144+
145+
# Build static site
146+
mkdocs build
147+
```
148+
149+
## Contributing to Documentation
150+
151+
When updating these docs:
152+
153+
1. **Use clear, concise language** - Write for users of all skill levels
154+
2. **Include code examples** - Show don't tell
155+
3. **Test examples** - Ensure all code examples work
156+
4. **Update cross-references** - Keep links between docs accurate
157+
5. **Follow the structure** - Maintain consistent formatting
158+
6. **Add to index** - Update navigation when adding new sections
159+
160+
## Documentation Coverage
161+
162+
This documentation covers:
163+
164+
- ✅ Installation and setup
165+
- ✅ Configuration management
166+
- ✅ Process development with PythonLab
167+
- ✅ SiLA 2 integration
168+
- ✅ Complete API reference
169+
- ✅ Production deployment
170+
- ✅ Security best practices
171+
- ✅ Monitoring and troubleshooting
172+
- ✅ Code examples throughout
173+
174+
## Getting Help
175+
176+
If you can't find what you're looking for:
177+
178+
1. Check the [index](index.md) for an overview
179+
2. Use the search feature (if using MkDocs)
180+
3. Look at example processes in `tests/test_data/`
181+
4. Run `invoke test` to see working configurations
182+
5. Review the project's CLAUDE.md file for development guidance
183+
184+
## Version Information
185+
186+
This documentation is for Lab Orchestrator version **0.2.8**.
187+
188+
Last updated: 2025-10-22
189+
190+
## License
191+
192+
This documentation is part of the Lab Orchestrator project. Refer to the main project repository for license information.

0 commit comments

Comments
 (0)