Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,3 @@ jobs:

- name: Format check
run: npm run format:check

docs:
name: Documentation Build
runs-on: ubuntu-latest
# TODO: Enable when docs are migrated from smartem-decisions
if: false

steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: "3.11"

- name: Install dependencies
run: |
pip install sphinx myst-parser sphinx-copybutton sphinx-design pydata-sphinx-theme

- name: Build docs
run: sphinx-build -E docs build/html
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,16 @@ Opens at http://localhost:5173

### Documentation

Documentation is built with Sphinx and published to GitHub Pages from smartem-decisions.
Documentation is built as part of the webui and published to GitHub Pages.

```bash
# Build locally (requires sphinx)
cd docs
sphinx-build -E . ../build/html
# Build locally
cd webui
npm install
npm run build
```

View at: https://diamondlightsource.github.io/smartem-decisions/
View at: https://diamondlightsource.github.io/smartem-devtools/

## Claude Code Configuration

Expand Down
2 changes: 1 addition & 1 deletion claude-code/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ export ARIA_GQL_LOCAL=http://localhost:9002/graphql
| smartem-frontend | Regenerate OpenAPI client |
| smartem-agent | Update api_client imports |
| fandanGO-cryoem-dls | Update SmartEMAPIClient |
| Docs | Regenerate OpenAPI spec, Sphinx |
| Docs | Regenerate OpenAPI spec |
| Containers | Rebuild images |

### When smartem-backend MQ schema changes
Expand Down
2 changes: 1 addition & 1 deletion claude-code/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Developer tooling, documentation, and workspace configuration for the SmartEM ec
- API specs (SmartEM, Athena)

**Key directories:**
- `docs/` - Sphinx documentation, ADRs, how-to guides
- `docs/` - Markdown documentation, ADRs, how-to guides (synced to webui as MDX)
- `claude-code/` - Skills, repo guidelines, architecture docs
- `webui/` - React developer dashboard
- `core/` - Repository and workspace config definitions
Expand Down
43 changes: 20 additions & 23 deletions claude-code/shared/skills/technical-writer/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,30 +185,33 @@ Licence information.
- Link to detailed documentation
- Keep it scannable (headers, bullets, code blocks)

## Sphinx Documentation
## Documentation (smartem-devtools)

### Build Commands

```bash
cd repos/DiamondLightSource/smartem-decisions
cd repos/DiamondLightSource/smartem-devtools/webui

# Full build
sphinx-build -E docs build/html
# Install dependencies
npm install

# Live reload during writing
sphinx-autobuild docs build/html
# Development server with hot reload
npm run dev

# Check links
sphinx-build -b linkcheck docs build/linkcheck
# Production build
npm run build
```

### Adding New Pages

1. Create `.md` file in appropriate `docs/` subdirectory
2. Add to `toctree` in parent `index.md`
3. Use MyST Markdown syntax
2. Add link to the appropriate navigation file (`docs/how-to.md`, `docs/explanations.md`, etc.)
3. Update `webui/src/docs/navigation.ts` if adding to sidebar
4. Run `npm run prebuild` to sync changes (automatic in dev mode)

### MyST Markdown Features
### Markdown Features

Documentation uses standard GitHub Flavored Markdown:

```markdown
# Headings use standard Markdown
Expand All @@ -219,19 +222,13 @@ def example():
pass
```

Admonitions:
```{note}
This is a note.
```
**Bold**, *italic*, `inline code`

```{warning}
This is a warning.
- Bullet lists
- [Links](/docs/path/to/page)
```

Cross-references:
{ref}`label-name`
{doc}`path/to/document`
```
**Note**: Avoid curly braces `{}` in prose as they're interpreted as JSX. Use backticks for values like `` `<10ms` ``.

## Common British vs American Spellings

Expand Down Expand Up @@ -272,5 +269,5 @@ Before finalising documentation:
## References

- ADR format: https://adr.github.io/
- MyST Markdown: https://myst-parser.readthedocs.io/
- Sphinx: https://www.sphinx-doc.org/
- GitHub Flavored Markdown: https://github.github.com/gfm/
- MDX: https://mdxjs.com/
10 changes: 4 additions & 6 deletions claude-code/smartem-decisions/REPO-GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,8 @@ ruff format
# Pre-commit checks
pre-commit run --all-files

# Documentation
sphinx-build -E docs build/html
sphinx-autobuild docs build/html # Live reload
# Documentation (see smartem-devtools webui)
cd ../smartem-devtools/webui && npm run dev

# Database migrations
python -m alembic upgrade head
Expand Down Expand Up @@ -97,10 +96,9 @@ python -m alembic revision --autogenerate -m "Description"
- **CI/CD**: GitHub Actions with pre-commit hooks

## Documentation
- **Sphinx**: Auto-generated API docs with Napoleon (Google-style docstrings)
- **MyST**: Markdown support in documentation
- **Live development**: Use sphinx-autobuild for real-time doc updates
- **Markdown**: Documentation in `docs/` synced to smartem-devtools webui as MDX
- **API documentation**: Swagger/OpenAPI specs auto-generated
- **Live development**: Run `npm run dev` in smartem-devtools/webui for hot-reload

## Available Skills

Expand Down
16 changes: 0 additions & 16 deletions docs/_api.rst

This file was deleted.

37 changes: 0 additions & 37 deletions docs/_templates/custom-module-template.rst

This file was deleted.

Loading