Skip to content

Documentation improvements - #22

Open
Wiebke wants to merge 2 commits into
mainfrom
documentation-improvements
Open

Documentation improvements#22
Wiebke wants to merge 2 commits into
mainfrom
documentation-improvements

Conversation

@Wiebke

@Wiebke Wiebke commented Feb 6, 2026

Copy link
Copy Markdown
Member

This PR improves repository documentation and configuration guidance to improve software accessibility and reproducibility. It clarifies the modular architecture, more explicitly points to the SAXSWAXS_workflows companion repo, and streamlines environment setup instructions.

Summary of changes:

  • Added a concise software-architecture overview emphasizing modular interfaces (Tiled + Prefect).
  • Clarified the role of SAXSWAXS_workflows and linked to the companion repo.
  • Simplified setup instructions and aligned them with a new example environment file .env.example.
  • Refined wording for consistency and readability.

@Wiebke
Wiebke requested a review from rajasriramoju February 6, 2026 20:40
Comment thread README.md
Comment thread README.md
All entries in `TILED_BLACKLIST` cause any directory or file containing a substring of the listed entries to be skipped.

## Beamtime setup: Start up a Tiled
## Beamtime Setup: Start up a Tiled

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be missing a word here. Tiled server?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants