Add H1 to pages

[gkorland]

Summary by CodeRabbit

• Documentation
  • Updated documentation to ensure main headings appear as H1 headers at the top of the "Kafka Connect Sink" and "Rest API" integration guides for improved readability and consistency.

[coderabbitai]

Walkthrough

The changes update the heading placement and formatting in two markdown documentation files. In both files, H1 headers are added or repositioned to appear immediately after the front matter, ensuring consistent structure. Banner images are also repositioned to follow the new H1 headers. No other content or structural changes were made.

Changes

File(s)	Change Summary
integration/kafka-connect.md	Moved the "Kafka Connect Sink" H1 header above the banner image; repositioned the banner image.
integration/rest.md	Added "# Rest API" H1 header after front matter and before the Table of Contents section.

Poem

A hop, a skip, a header leap,
Markdown files now tidy and neat.
Titles rise to take their place,
Banner images follow with grace.
In docs we trust, in structure we cheer,
Another update—let’s all give a bunny ear! 🐇

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between d2c1af5 and d82eeb6.

📒 Files selected for processing (2)

• integration/kafka-connect.md (1 hunks)
• integration/rest.md (1 hunks)

🔇 Additional comments (3)

integration/rest.md (1)

8-8: Insert H1 Header Immediately After Frontmatter
The addition of # Rest API right after the frontmatter aligns the main heading with the page title and enforces a consistent markdown structure across integration docs.

integration/kafka-connect.md (2)

8-8: Move Main Title to H1 Under Frontmatter
Switching to # Kafka Connect Sink immediately after the frontmatter ensures the primary title is rendered as an H1 and matches the document metadata.

---

10-10: Reposition Banner Image Below H1
Placing the banner image below the new H1 heading maintains a logical visual hierarchy, making the title the first element users see.

---

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 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.

[danshalev7]

@gkorland just making sure the best practice aligns with what we have
rationale calls for # Kafka Connect Sink to be our H1 for this page.

Please let me know if this is what you meant by "ah h1 to pages"

[danshalev7]

@gkorland Best Practices:

Place at the Top: Put the H1 title at the very beginning of your .md file to clearly indicate the page's main topic.
Use Only One H1: Stick to a single H1 per page to follow SEO best practices and maintain a clear content hierarchy.
Keep It Descriptive: Write a concise, relevant title that reflects the page's content (e.g., # Project Overview or # Installation Guide).

I think our # (or H1) for this page is wrong. Am I missing something?

[danshalev7]

This should be the H1: # Kafka Connect Sink