Skip to content

Commit fd49a28

Browse files
committed
WIP: docs/ restructuring
1 parent 0397b54 commit fd49a28

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+473
-153
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,4 +480,4 @@ The watch command requires a compatible SmartEM backend API with the following e
480480
- Consider `--heartbeat-interval` tuning based on network stability
481481
- Use `--dry-run` for local testing and development
482482

483-
This CLI reference provides comprehensive coverage of all SmartEM Agent command-line functionality. For additional help with specific use cases or troubleshooting, refer to the [CLI Troubleshooting Guide](troubleshoot-cli.md).
483+
This CLI reference provides comprehensive coverage of all SmartEM Agent command-line functionality. For additional help with specific use cases or troubleshooting, refer to the [CLI Troubleshooting Guide](troubleshooting.md).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The agent operates in several modes depending on the timing of EPU data acquisit
2727

2828
## Quick Start
2929

30-
For comprehensive parameter documentation, see the [CLI Reference](../reference/cli-reference.md). For troubleshooting, see the [CLI Troubleshooting Guide](troubleshoot-cli.md).
30+
For comprehensive parameter documentation, see the [CLI Reference](cli-reference.md). For troubleshooting, see the [CLI Troubleshooting Guide](troubleshooting.md).
3131

3232
### Basic Directory Monitoring
3333

docs/agent/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Agent
2+
3+
Documentation for the SmartEM Agent - the EPU filesystem watcher that runs on Windows workstations near the microscope.
4+
5+
```{toctree}
6+
:maxdepth: 1
7+
8+
cli-reference
9+
deployment
10+
troubleshooting
11+
```
12+
13+
## Topics
14+
15+
### Usage
16+
17+
- [CLI Reference](cli-reference.md) - Command-line interface documentation and options
18+
- [Troubleshooting](troubleshooting.md) - Common issues and solutions
19+
20+
### Deployment
21+
22+
- [Agent Deployment](deployment.md) - Running the agent on Windows workstations
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SmartEM CLI Troubleshooting Guide
22

3-
This guide provides solutions for common issues encountered when using the SmartEM Agent command-line interface. For comprehensive parameter documentation, see the [CLI Reference](../reference/cli-reference.md).
3+
This guide provides solutions for common issues encountered when using the SmartEM Agent command-line interface. For comprehensive parameter documentation, see the [CLI Reference](cli-reference.md).
44

55
## Quick Diagnostics
66

docs/architecture/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Architecture
2+
3+
System design documentation and architectural decision records.
4+
5+
## Decision Records
6+
7+
Architectural Decision Records (ADRs) document significant technical decisions.
8+
9+
- [Decision Records](../decision-records/index.md) - Browse all ADRs
10+
11+
## System Design
12+
13+
Architecture documentation is maintained in the main smartem-decisions repository:
14+
15+
- System overview and component interactions
16+
- Backend-Agent communication protocols (SSE, REST)
17+
- Data flow and message queue patterns
18+
- Database schema design

docs/athena/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Athena Integration
2+
3+
Documentation for ThermoFisher Athena API integration.
4+
5+
## API Reference
6+
7+
The Athena Decision Service API specification is available in the API documentation:
8+
9+
- [Athena API Docs](../api/athena/index.html) - Interactive Swagger UI
10+
- [API Documentation Guide](../backend/api-documentation.md) - How to use the interactive documentation
11+
12+
## Mock Server
13+
14+
For local development without access to a real Athena service:
15+
16+
```bash
17+
# Install mock dependencies
18+
pip install -e ".[mock]"
19+
20+
# Start the Athena mock server
21+
python -c "
22+
from athena_api.mock import AthenaAPIServer
23+
server = AthenaAPIServer()
24+
server.run()
25+
"
26+
27+
# Visit http://localhost:8000/docs
28+
```
29+
30+
See the [API Documentation](../backend/api-documentation.md#mock-server-for-development) guide for more details.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ The core backend service providing HTTP API, database operations, and message qu
1010

1111
# launch RabbitMQ worker (consumer)
1212
python -m smartem_backend.consumer # ERROR level (default)
13-
python -m smartem_backend.consumer -v # INFO level
13+
python -m smartem_backend.consumer -v # INFO level
1414
python -m smartem_backend.consumer -vv # DEBUG level
1515

16-
# simulating an system event:
16+
# simulating an system event:
1717
python -m smartem_backend.simulate_msg --help # to see a list of options
1818
./tools/simulate-messages.sh # run a simulation, triggering system events in sequence
1919

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def upgrade() -> None:
140140
column('preference_key', sa.String),
141141
column('preference_value', sa.JSON)
142142
)
143-
143+
144144
op.bulk_insert(user_preferences, [
145145
{
146146
'user_id': 'system',
File renamed without changes.

0 commit comments

Comments
 (0)