docs: adjust table of contents

[jdegand]

There is still an issue with awesome-lint related to headings of the contents. But this change removes a lot of warnings.

Summary by CodeRabbit

• Documentation
  • Improved and standardized formatting of section titles and list items in the README.
  • Renamed "Table of contents" to "Contents" and ensured consistent capitalization throughout.
  • Made minor spacing adjustments and removed a duplicate section for better readability.

[coderabbitai]

Walkthrough

The README.md file was updated to standardize formatting and capitalization of section titles and list items. Headings and subsections were made consistent, some list items were capitalized, and minor spacing adjustments were applied. No content or functionality was changed; the updates are purely stylistic and organizational.

Changes

Cohort / File(s)	Change Summary
README Formatting Updates README.md	Standardized section and list capitalization, renamed headings, adjusted spacing, and removed a duplicate section. No content changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs: various awesome-lint fixes #1553: Focuses on stylistic and formatting improvements to the README.md file, similar in nature to this PR.
• docs: remove templates and more #1520: Involves stylistic and organizational changes to the README.md, related in purpose though modifying different aspects.

Poem

Hopping through docs, I tidy with glee,
Capitalizing titles for all to see.
A heading renamed, a list now aligned,
Spacing adjusted, perfection in mind.
No code was changed, just order restored—
A README refreshed, by a rabbit adored! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bcab537 and e624754.

📒 Files selected for processing (1)

• README.md (13 hunks)

🔇 Additional comments (9)

README.md (9)

17-18: Heading rename looks good – just verify linting passes

Renaming “Table of contents” to “Contents” is consistent with Awesome-Lint’s recommendations. No action needed unless you still see warnings after the run.

---

26-29: Capitalisation of X-sub-items is fine, but double-check the anchors

The links in the TOC still point to #angular-team, #experts, and #google-developer-experts, which remain unchanged when Markdown normalises the now-capitalised headings, so no additional work is required.

---

46-48: Consistent title-case for section names

Aligning “Developer Tools” and “Documentation Tools” with the rest of the list helps readability and removes Awesome-Lint warnings. Nice catch.

---

68-69: “E2E” heading – OK

Upper-casing matches industry convention; anchor slug (#e2e) remains unchanged.

---

101-103: “Mixed Utilities” capitalisation

No functional impact, but improves visual consistency.

---

116-120: UI-library subgroup headings updated – anchors unchanged

Material-, Bootstrap-, Tailwind- and Node-based subsections now follow title-case. Links in the body already reference these slugs, so nothing else to tweak.

---

219-231: “Google Developer Experts” sub-heading

Good alignment with the other X-sub-groups. Confirm that no inbound links from outside the repo depended on the old lower-case heading.

---

376-381: Inserted “Style Guides” under Learning: watch for duplicate anchors

A previous duplicate section farther down was removed, so we’re safe. Make sure the single remaining ### Style Guides anchor is unique (Awesome-Lint will warn if not).

---

1579-1580: Section heading capitalisation mirrored in TOC

The body heading now matches the earlier TOC bullet. All good.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.