Skip to content
This repository was archived by the owner on Jun 5, 2026. It is now read-only.

TNDO-6622 Add component documentation template#161

Open
tog-leanix wants to merge 1 commit into
mainfrom
feature/TNDO-6622-add-component-documentation
Open

TNDO-6622 Add component documentation template#161
tog-leanix wants to merge 1 commit into
mainfrom
feature/TNDO-6622-add-component-documentation

Conversation

@tog-leanix

Copy link
Copy Markdown
Contributor

Component Documentation — Call to Action

This PR adds an empty COMPONENT_DOCUMENTATION.md template to the repository root.
Your task is to fill it out using the AI-assisted prompt we've prepared.

What to do

  1. Check out this branch

    git fetch origin
    git checkout feature/TNDO-6622-add-component-documentation
    
  2. 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.

  3. Commit and push your changes

    git add COMPONENT_DOCUMENTATION.md
    git commit -m "TNDO-6622 Fill out component documentation"
    git push
    
  4. Request a review from a teammate and merge into main

Why

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.

@tog-leanix tog-leanix requested a review from a team as a code owner April 15, 2026 09:06
@tog-leanix tog-leanix requested review from ama-leanix, geb-leanix, jah-leanix, mal-leanix and mathiasb-beep and removed request for a team April 15, 2026 09:06
@internal-ai-adoption-analytics

Copy link
Copy Markdown

📊 Survey: Please help us track internal AI adoption. This is not for evaluation, only for metrics. You can update this anytime before merge.
🤖 Which AI developer tool(s), if any, were used to assist with this PR? Please tick one or more boxes below:

  • None
  • Cline
  • Claude Code
  • Cursor
  • GitHub Copilot
  • Other

🧑‍💻 If AI was used, what was it mainly used for?

  • Coding / Implementation
  • Testing (unit, integration, e2e)
  • Documentation
  • Research / Investigation
  • Refactoring / Cleanup
  • Configuration / DevOps
  • Other

Thank you in advance for your feedback.💙🙏🎉
Here's a joke to brighten your day: Future forecast: AIs will eventually demand coffee breaks... for their GPUs! ☕

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant