Skip to content

Commit e4b2336

Browse files
authored
Adding beginner docs thanks to copilot (#1382)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent a757585 commit e4b2336

File tree

8 files changed

+1521
-1
lines changed

8 files changed

+1521
-1
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Changelog
22

3+
# Unreleased
4+
5+
## Added
6+
7+
- Beginner documentation: conceptual overview, architecture guide, glossary, and CLI examples
8+
- Beginner Resources section in main README (top-level)
9+
10+
## Changed
11+
12+
- `examples/beginner_simulation.py`: use local config, display devices, fix simulators parameter
13+
- Documentation: clickable links, CLI-first approach, plain language
14+
315
# 0.7.8
416

517
## Generic

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,17 @@ PANOPTES unit, responsible for high-level control of the unit.
2929

3030
For more information, see the full documentation at: https://pocs.readthedocs.io.
3131

32+
## Beginner Resources
33+
34+
New to POCS? Start here:
35+
36+
- **CLI Guide:** See [docs/cli-guide.md](docs/cli-guide.md) for complete command line reference
37+
- **Command Line Examples:** Quick start at [examples/README.md](examples/README.md)
38+
- **Conceptual Overview:** Read [docs/conceptual-overview.md](docs/conceptual-overview.md) to understand POCS without installing
39+
- **Architecture Guide:** Read [docs/architecture-for-beginners.md](docs/architecture-for-beginners.md) to understand how POCS works
40+
- **Glossary:** Check [docs/glossary.md](docs/glossary.md) for definitions of all terms
41+
- **Python Examples:** Run [examples/beginner_simulation.py](examples/beginner_simulation.py) for API tutorial (advanced)
42+
3243
## Install
3344

3445
### POCS Environment
@@ -117,7 +128,33 @@ Out[10]: False
117128

118129
For a more realistic usage, see the full documentation at: [https://pocs.readthedocs.io](https://pocs.readthedocs.io).
119130

120-
For actually deploying a PANOPTES unit, refer to the [Operating Guider](https://projectpanoptes.gitbook.io/pocs-user-guide/operation/operating-guides).
131+
For actually deploying a PANOPTES unit, refer to the [Operating Guide](https://projectpanoptes.gitbook.io/pocs-user-guide/operation/operating-guides).
132+
133+
#### Using POCS
134+
135+
POCS provides a command line interface for all operations. After installation:
136+
137+
**1. Configure your unit (required first step):**
138+
```bash
139+
pocs config setup
140+
```
141+
142+
**2. Run automated observing:**
143+
```bash
144+
pocs run auto
145+
```
146+
147+
**3. Manual hardware control:**
148+
```bash
149+
# Mount control
150+
pocs mount slew-to-target --target M42
151+
pocs mount park
152+
153+
# Camera testing
154+
pocs camera take-pics --num-images 5 --exptime 2.0
155+
```
156+
157+
For more CLI commands, run `pocs --help` or see the beginner documentation above.
121158

122159
#### Developing POCS
123160

0 commit comments

Comments
 (0)