Skip to content

docs: add HPC customization notice where simulate.config is referenced#5

Merged
MSiggel merged 1 commit intomainfrom
docs/hpc-customization-notice
Apr 10, 2026
Merged

docs: add HPC customization notice where simulate.config is referenced#5
MSiggel merged 1 commit intomainfrom
docs/hpc-customization-notice

Conversation

@MSiggel
Copy link
Copy Markdown
Collaborator

@MSiggel MSiggel commented Apr 10, 2026

Summary

  • Added <Callout type="warn"> to three doc pages that reference simulate.config without warning that its SLURM settings are cluster-specific
  • Each callout directs users to edit the config and links to the existing Running on HPC Clusters guide

Pages updated:

  • quick-start.mdx
  • user-guide/workflows.mdx
  • user-guide/tutorial-mixedbox-campaign.mdx

Closes #4

Test plan

  • Run cd docs && npm run dev and verify the callout renders on all three pages
  • Confirm the "Running on HPC Clusters" link works from each callout

🤖 Generated with Claude Code

The shipped simulate.config contains SLURM settings specific to one
cluster. Pages that show the simulate command now warn users to adapt
the config and link to the Running on HPC Clusters guide.

Closes #4

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 10, 2026

CLA assistant check
All committers have signed the CLA.

@MSiggel MSiggel merged commit 6d83e1e into main Apr 10, 2026
5 checks passed
@MSiggel MSiggel deleted the docs/hpc-customization-notice branch April 10, 2026 11:33
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.

docs: add HPC customization notice where simulate.config is referenced

3 participants