TNDO-6622 Add component documentation template#161
Open
tog-leanix wants to merge 1 commit into
Open
Conversation
|
📊 Survey: Please help us track internal AI adoption. This is not for evaluation, only for metrics. You can update this anytime before merge.
🧑💻 If AI was used, what was it mainly used for?
Thank you in advance for your feedback.💙🙏🎉 |
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.
Component Documentation — Call to Action
This PR adds an empty
COMPONENT_DOCUMENTATION.mdtemplate tothe repository root.Your task is to fill it out using the AI-assisted prompt we've prepared.
What to do
Check out this branch
Run the documentation prompt
Open this repo in your CLI AI tool (OpenCode, Copilot, Cursor, etc.) and execute the prompt found here:
👉 https://leanix.atlassian.net/wiki/spaces/Reporting/pages/10241966599/Component+Documentation+Prompt
The agent will scan your codebase, auto-fill what it can, ask you about the rest, and write the completed document directly into
COMPONENT_DOCUMENTATION.md.Commit and push your changes
Request a review from a teammate and merge into
mainWhy
Consistent component documentation helps with on-call handoffs, incident response, and onboarding.
This is a tribe-wide initiative to ensure every component has baseline operational documentation.