Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Conversation

@ivanmilevtues
Copy link

What?

This PR includes documentation enhanced with Mermaid diagrams that represent the codebase at a high level. You can view how they’re rendered here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/stackstorm_pack_ansible/on_boarding.md

We’re generating these diagrams using a combination of static analysis and LLMs. We’ve also built a GitHub Action that you can add to any repository—it automatically updates the diagrams on every merge to main, release, or based on other heuristics.

Why?

The goal of these documents is to help people get up to speed quickly with the stackstorm_pack_ansible codebase. Considering that stackstorm_pack_ansible is a core component for other projects, I suppose a lot of people interact with it. The diagrams are designed to make codebases more approachable—especially for those who use code as a tool rather than as professional software engineers.

We believe this can be especially helpful in organizations like Pfizer, where many scientists and domain experts write or interact with code to support their work. We'd love to hear if diagrams like these could improve your onboarding or collaboration processes. What does your current onboarding look like? Do you think auto-generated, diagram-first documentation could play a role?

We’d really love to connect and learn more about your needs—whether it's around onboarding, documentation, or helping people work more effectively with code. If you’re open to a quick chat, we’d be excited to explore how we can support your team.

@ivanmilevtues ivanmilevtues requested a review from a team as a code owner July 5, 2025 00:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant