Skip to content

docs(readme): add Table of Contents and improve documentation layout#29

Merged
coolert merged 1 commit intomainfrom
docs/add-readme-toc
Dec 9, 2025
Merged

docs(readme): add Table of Contents and improve documentation layout#29
coolert merged 1 commit intomainfrom
docs/add-readme-toc

Conversation

@coolert
Copy link
Copy Markdown
Owner

@coolert coolert commented Dec 9, 2025

PR Summary

Add a Table of Contents to the README and improve documentation structure, including visual separation around the Health Check section. No functional or API changes.


Changes

  • Added Table of Contents to README for improved navigation
  • Added a horizontal rule (---) below the Health Check section for clearer visual separation
  • Improved README layout and section transitions
  • Updated internal anchors to match section headings
  • No modifications to application logic or API behavior

Type of Change

  • Feature
  • Fix
  • Docs
  • Refactor
  • CI
  • Other

- Added README Table of Contents for easier navigation
- Improved visual separation around Health Check section
- Updated internal anchors and refined documentation structure
@coolert coolert merged commit d5efc68 into main Dec 9, 2025
2 checks passed
@coolert coolert deleted the docs/add-readme-toc branch December 9, 2025 12:32
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