Add toc to README and lint contributing.md #461

Merged
pat-s merged 4 commits from readme-toc into main 2023-06-28 06:54:25 +00:00
Member

Description of the change

  • Add ToC to README for easier navigation (and add note to contributing.md)
  • Fix some heading levels in README
  • Put upgrading notes into collapsible blocks
  • Format contributing.md according to MD rules
  • Allow details and summary elements in README
  • Allow for longer headings

Benefits

Better documentation

Possible drawbacks

None

### Description of the change - Add ToC to README for easier navigation (and add note to `contributing.md`) - Fix some heading levels in README - Put upgrading notes into collapsible blocks - Format `contributing.md` according to MD rules - Allow `details` and `summary` elements in README - Allow for longer headings ### Benefits Better documentation ### Possible drawbacks None
pat-s added 3 commits 2023-06-27 20:24:48 +00:00
pat-s added 1 commit 2023-06-27 20:30:35 +00:00
All checks were successful
check-and-test / check-and-test (pull_request) Successful in 35s
4a83c0a1ac
lint
pat-s requested review from justusbunsi 2023-06-27 20:31:25 +00:00
lunny approved these changes 2023-06-28 03:03:02 +00:00
pat-s merged commit 81252dcb18 into main 2023-06-28 06:54:25 +00:00
pat-s deleted branch readme-toc 2023-06-28 06:54:26 +00:00
Sign in to join this conversation.
No description provided.