Skip to content

Distinct notebook headlines and README table of contents - #5

Merged
jan-janssen merged 1 commit into
mainfrom
fixes
Aug 10, 2026
Merged

jan-janssen merged 1 commit into
mainfrom
fixes

Conversation

@jan-janssen

Copy link
Copy Markdown
Contributor

Summary

  • Give each notebook a short, distinct headline (<=25 characters) so the combined Jupyter Book sidebar is easy to scan instead of showing "executorlib with SLURM" three times:
    • slurm_demo_v1.ipynb -> "Getting Started"
    • slurm_error_v1.ipynb -> "Submission Errors"
    • slurm_with_flux_v1.ipynb -> "SLURM with Flux"
    • slurm_with_lammps_v1.ipynb -> "SLURM with LAMMPS"
    • slurm_with_nested_executor.ipynb -> "Nested SLURM Jobs"
  • Add a Table of Contents to README.md linking to each page of the deployed site
  • Includes the pending README typo fix ("example" -> "examples")
  • No Python code was changed — headline text and README only

Test plan

  • Verified via diff that all code cells are byte-identical to main
  • Verified all notebooks still parse as valid JSON
  • Confirmed each new headline is <=25 characters and unique
  • Not executed — notebooks require a live SLURM cluster and were edited from a local laptop

Three notebooks shared the same "executorlib with SLURM" H1, which
was confusing in the combined Jupyter Book sidebar. Give each
notebook a unique headline under 25 characters, fix a README typo,
and add a Table of Contents linking to each page of the deployed
site. No Python code was changed.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@jan-janssen
jan-janssen merged commit 1f2e417 into main Aug 10, 2026
1 check passed
@jan-janssen
jan-janssen deleted the fixes branch August 10, 2026 08: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