You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Our team currently lacks a standardized process for updating the Wiki when issues are closed. This leads to inconsistent or missing documentation of changes, features, and fixes.
Describe the solution you'd like
A clear, structured process for manually updating the Wiki when issues are closed:
A template for Wiki updates that includes:
- Feature/fix description
- Usage instructions like API details or the component navigation details etc
- Configuration details (if applicable)
- Related issue/PR references
A designated section in issue/PR templates for Wiki content
Clear guidelines on which types of changes require Wiki updates
A standard location/structure in the Wiki for different types of updates
Acceptance criteria
Script automatically triggers when an issue is marked as closed in GitHub
Script extracts relevant documentation content from the issue (specifically from a designated "Wiki Documentation" section in the issue)
If a "Wiki Documentation" section exists in the issue:
- Script identifies the appropriate Wiki page to update based on tags/categories
- Successfully adds the new content to the existing Wiki page
- Maintains proper markdown formatting
- Adds metadata (issue number, closure date, contributor)
If no Wiki documentation section exists, script skips the issue without error
Script notifies relevant team members (via GitHub comment or other specified channel) when:
- Wiki update is successful
- Update fails for any reason
The text was updated successfully, but these errors were encountered:
@DeviPriya-Kolla What is the purpose of this Wiki and why would we want to duplicate information into it? GitHub already keeps information about closed issues, when they were closed, and with what PR (if developers properly tag their PRs)
Like we have to go through all the issues to understand what features are implemented or closed, instead with every closed issue if we update the wiki, we will have all the information in one place.
Is your feature request related to a problem? Please describe.
Our team currently lacks a standardized process for updating the Wiki when issues are closed. This leads to inconsistent or missing documentation of changes, features, and fixes.
Describe the solution you'd like
A clear, structured process for manually updating the Wiki when issues are closed:
- Feature/fix description
- Usage instructions like API details or the component navigation details etc
- Configuration details (if applicable)
- Related issue/PR references
Acceptance criteria
- Script identifies the appropriate Wiki page to update based on tags/categories
- Successfully adds the new content to the existing Wiki page
- Maintains proper markdown formatting
- Adds metadata (issue number, closure date, contributor)
- Wiki update is successful
- Update fails for any reason
The text was updated successfully, but these errors were encountered: