Skip to content

docs: first workflow run user guide#784

Open
Kevin Loftus (kevin-loftus-dept) wants to merge 1 commit into
developmentfrom
docs/egv-168-first-workflow-run-user-guide
Open

docs: first workflow run user guide#784
Kevin Loftus (kevin-loftus-dept) wants to merge 1 commit into
developmentfrom
docs/egv-168-first-workflow-run-user-guide

Conversation

@kevin-loftus-dept
Copy link
Copy Markdown
Contributor

Add end-to-end first workflow run user guide (DOCS-01)

Type of Change*

  • New feature
  • Bug fix
  • Documentation update
  • Refactoring
  • Hotfix
  • Security patch
  • UI/UX improvement

Description

Closes the highest-impact documentation gap for post-deploy users: a single guide that walks bioinformaticians and lab managers through the core platform journey after installation.

Added

  • docs/getting-started/first-workflow-run.md — end-to-end guide covering login, org/lab setup, team invites, sample upload (manifest + auto sample sheet), workflow launch, run monitoring, and output download
  • 25 UI screenshots in docs/getting-started/assets/ referenced from the guide
  • Covers both supported platforms: Seqera Cloud and AWS HealthOmics (parallel run paths, shared upload steps)
  • Prod vs non-prod callout (seeded test data vs greenfield org creation)

Updated

The guide is written to be self-contained after prerequisites + install. Troubleshooting and pipeline authoring are out of scope (linked externally where relevant).

Testing*

  • Read through the guide as a post-deploy user; confirmed internal links and screenshot paths resolve
  • Verified both Seqera and HealthOmics sections are present and structurally complete
  • Manual walkthrough on a live deployment (recommended for reviewer)

Impact

Documentation-only change. No application code, dependencies, or runtime behaviour affected.

Additional Information

Screenshots were captured against the quality UAT environment UI. Reviewers may want to spot-check that screenshot content matches current product labels.

Related: DOCS-01 / EGV-168

Checklist*

  • No new errors or warnings have been introduced.
  • All tests pass successfully and new tests added as necessary.
  • Documentation has been updated accordingly.
  • Code adheres to the coding and style guidelines of the project.
  • Code has been commented in particularly hard-to-understand areas.

@kevin-loftus-dept Kevin Loftus (kevin-loftus-dept) force-pushed the docs/egv-168-first-workflow-run-user-guide branch from 18f24f4 to 1b9ce49 Compare June 3, 2026 21:13
@kevin-loftus-dept Kevin Loftus (kevin-loftus-dept) marked this pull request as ready for review June 3, 2026 21:13
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.

1 participant