Skip to content

Handbook Changes Over Time#

Changelog#

0.5.0 (2024-11-06)#

Features#

  • add footnotes support and enhance social links in MkDocs configuration (1a4dd35)
  • add guiding principles for contributing to the handbook (#52) (31e196e)
  • add header autohide feature, reorganize markdown extensions (fc994d8)
  • add markdownlint configuration and ignore rules for improved linting (0fe0d8a)
  • enhance contributing documentation with clearer instructions and new examples (6d7cc6b)
  • link hpc4health site under software development (#51) (f7361aa)
  • update onboarding / offboarding section (#53) (3c86b05)

0.4.0 (2024-11-04)#

Features#

  • add Markdown and MkDocs documentation sections for improved clarity and guidance (90d0e7e)
  • add repository name to mkdocs configuration and update icon reference (6bc7cd1)
  • improve clarity in contributing guide by refining section headings and adding notes (f8b37f1)
  • refactor software development documentation structure with new sections on development environment and related tools (05eb33b)

Bug Fixes#

  • formatting (5c25c0e)
  • formatting (5c25c0e)
  • git config --local only if we checkout (f819f89)
  • lint files (2c958fb)
  • revise handbook introduction and contribute guidelines for clarity and better onboarding experience (2c958fb)

0.3.1 (2024-10-29)#

Bug Fixes#

  • use github action for deployment (f48ce66)

0.3.0 (2024-10-29)#

Features#

  • enhance release workflow to publish version of docs using mike after PR release (72345a7)
  • use mike (ec14831)

Bug Fixes#

0.2.0 (2024-10-29)#

Features#

  • Add issue templates (#28) (0a2c861)
  • Add release and deployment documentation; update pixi.lock for dependencies and versions (27bd2fd)
  • Create detailed guide for submitting issues, including templates and tips for effective reporting (ac69542)
  • replace discipline temp files with index.md pages, organize disciplines (ae1bb27)
  • Update issue templates for bug reports, content updates, documentation questions, and enhancements (30ee8d5)

Bug Fixes#

  • broken links in disciplines home tab (9393314)
  • CI to fetch from depth 0 (dbcae75)
  • remove deploy task so users dont mess it up (92fb375)
  • update git push command in adding_content.md to set upstream for new branch; fixes #30 (df76944)

0.1.0 (2024-10-25)#

Features#

  • add Conventional PR name check (#22) (beb1149)
  • add documentation on Contributing (156c47e)
  • add new documentation for code reviews and merging process, improving contributing guidelines for maintainers (#23) (156c47e)
  • major updates (76ce766)
  • Set up project structure with MkDocs, added configuration, documentation files, and specified dependencies in pixi.toml (0c17072)
  • update structure (ceb66dd)

Bug Fixes#

Miscellaneous Chores#