Ensure recent markdown files pass pre-commit verifications

[fschuch]

Summary by CodeRabbit

• Documentation

  • Expanded setup and template docs with Jupyter Book, CI/CD guidance, project management notes, and a clearer first-time setup step.

• Style

  • Formatting and minor textual corrections across README and contribution guides.

• Chores

  • CI workflow adjusted to run on all pull requests (removed path-based trigger restrictions).

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation and CI configuration updates: Copilot instructions expanded with setup, docs, project-management, and CI/CD notes; README and contribution docs receive minor formatting/text fixes; CI workflow pull_request path filters removed so PRs trigger the workflow regardless of modified paths.

Changes

Cohort / File(s)	Summary
AI & Copilot Guidance .github/copilot-instructions.md	Expanded documentation: adds Jupyter Book mention, CI/CD and Hatch project-management notes, and explicit first-time setup instructions (including removing the wizard after completion). Changes are documentation-only.
Project Documentation README.md, docs/references/how-to-contribute.md	Minor textual/formatting edits: blank line added in README; stray comma removed in contribution example.
CI Workflow .github/workflows/ci.yaml	Removed pull_request path filters so the CI workflow triggers on pull requests regardless of which files were modified.

Sequence Diagram(s)

(omitted — changes are documentation/configuration-only and do not introduce new multi-component control flow requiring a sequence diagram.)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Changed project from flat layout to src layout #22 — Related changes to .github/workflows/ci.yaml pull_request path filters.
• feat: added zizmor for static analysis tool for GitHub Actions #36 — Also updates CI trigger path filters in .github/workflows/ci.yaml.
• Fixed a couple issues #37 — Modifies CI workflow triggers; closely related to this PR's CI change.

Suggested labels

docs, changed

Poem

🐰 I nibbled notes and nudged a line,

Jupyter paths and CI now shine.
The wizard hops away, polite and spry,
Docs refreshed beneath the sky.
Carrot crumbs of clarity — hop, bye-bye! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the primary changes: markdown formatting fixes (comma removal, whitespace additions) that ensure files pass pre-commit linting verification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch lint/fix-markdown-lint

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @.github/copilot-instructions.md:
- Around line 140-145: The markdown ordered list items ("Add/update tests as
needed" and "Run QA checks: `hatch run qa`") run together in some renderers;
update the list in .github/copilot-instructions.md so there is explicit
separation — either add a period at the end of "Add/update tests as needed." or
insert a blank line between that item and "Run QA checks: `hatch run qa`" to
ensure they render as distinct list entries.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud