Add changelog guidelines block#483
Open
pinkevmladchy wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add change log guidelines block to each item type at the end of the page.