Skip to content

Add changelog guidelines block#483

Open
pinkevmladchy wants to merge 4 commits into
developfrom
changelog-guidelines
Open

Add changelog guidelines block#483
pinkevmladchy wants to merge 4 commits into
developfrom
changelog-guidelines

Conversation

@pinkevmladchy

Copy link
Copy Markdown
Contributor

Add change log guidelines block to each item type at the end of the page.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a reusable “Writing the changelog” guidelines section to the end of each ThingsBoard IoT Hub contribution guide page, ensuring consistent instructions across all item types.

Changes:

  • Introduced a new MDX include block containing changelog writing guidelines and an example.
  • Imported and rendered the new <ChangelogGuidelines /> block at the end of each IoT Hub guide page (device, widget, rule chain, alarm rule, calculated field, solution template).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/content/docs/docs/iot-hub/guides/widget.mdx Imports and renders the shared changelog guidelines block at the end of the widget guide.
src/content/docs/docs/iot-hub/guides/solution-template.mdx Imports and renders the shared changelog guidelines block at the end of the solution template guide.
src/content/docs/docs/iot-hub/guides/rule-chain.mdx Imports and renders the shared changelog guidelines block at the end of the rule chain guide.
src/content/docs/docs/iot-hub/guides/device.mdx Imports and renders the shared changelog guidelines block at the end of the device guide.
src/content/docs/docs/iot-hub/guides/calculated-field.mdx Imports and renders the shared changelog guidelines block at the end of the calculated field guide.
src/content/docs/docs/iot-hub/guides/alarm-rule.mdx Imports and renders the shared changelog guidelines block at the end of the alarm rule guide.
src/content/_includes/docs/iot-hub/guides/changelog-guidelines.mdx New shared documentation block describing changelog structure, semver guidance, and a sample entry.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants