Add comments to autogenerated content

[JakeSCahill]

Clarifies how to override descriptions and links to relevant documentation. Also includes a version bump for the package. These changes help make it clearer to contributors how to manage and update documentation content.

Documentation notice improvements:

• Updated the autogenerated content notice in all generated documentation files to include instructions for overriding descriptions using the doc-tools CLI, along with a link to the relevant documentation. This change was applied to property partials, deprecated properties, topic-property mappings, and example partials (tools/property-extractor/generate-handlebars-docs.js, tools/redpanda-connect/templates/examples-partials.hbs). [1] [2] [3] [4]

Version update:

• Bumped the package version from 4.10.4 to 4.10.5 in package.json to reflect these changes.

[netlify]

✅ Deploy Preview for docs-extensions-and-macros ready!

Name	Link
🔨 Latest commit	d39f0f2
🔍 Latest deploy log	https://app.netlify.com/projects/docs-extensions-and-macros/deploys/68fb9536707fe4000875e240
😎 Deploy Preview	https://deploy-preview-143--docs-extensions-and-macros.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This PR contains routine maintenance updates: a version bump from 4.10.4 to 4.10.5 in package.json, addition of an autogenerated notice header to three AsciiDoc output paths in the documentation generation tool, and enhancement of an autogenerated warning comment in a Handlebars template with user guidance on overriding descriptions via CLI.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

The changes are straightforward and primarily involve adding notice headers and comment text to generated documentation outputs. While affecting multiple output paths, the modifications are repetitive and low-complexity, requiring verification that the notice is consistently applied across the three specified locations and that the template guidance is clear and accurate.

Possibly related PRs

• Add support for saving properties to partials #140: Modifies tools/property-extractor/generate-handlebars-docs.js with changes to partials/pages generation and output paths, overlapping with this PR's modifications to AsciiDoc output handling.

Suggested reviewers

• paulohtb6
• mihaitodor

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Add comments to autogenerated content" directly aligns with the main objective of the changeset. According to the raw summary, the primary changes involve prepending autogenerated notice headers to generated AsciiDoc content in multiple output paths and adding a descriptive extension to an autogenerated warning comment. The title accurately captures this core change, and while there is a secondary version bump included in the PR, the title appropriately focuses on the most significant modification from the developer's perspective.
Description Check	✅ Passed	The PR description is well-related to the changeset and provides meaningful information about the changes. It clearly explains the documentation notice improvements, references the specific files modified (tools/property-extractor/generate-handlebars-docs.js and tools/redpanda-connect/templates/examples-partials.hbs), describes the intent to clarify how contributors can override descriptions, and notes the accompanying version bump. The description avoids vague language and effectively communicates the purpose and scope of the changes.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

---

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8c5f812 and e81e72c.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• package.json (1 hunks)
• tools/property-extractor/generate-handlebars-docs.js (3 hunks)
• tools/redpanda-connect/templates/examples-partials.hbs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Redirect rules - docs-extensions-and-macros
• GitHub Check: Header rules - docs-extensions-and-macros
• GitHub Check: Pages changed - docs-extensions-and-macros

🔇 Additional comments (2)

package.json (1)

3-3: LGTM! Appropriate version bump for documentation enhancements.

The patch version increment correctly reflects the non-breaking documentation improvements in this PR.

tools/redpanda-connect/templates/examples-partials.hbs (1)

2-2: LGTM! Clear guidance for contributors.

The enhanced autogenerated notice provides actionable instructions and a relevant documentation link, making it easier for contributors to understand how to override content appropriately.