Skip to content

Conversation

ivanmilevtues
Copy link

This PR contains high-level diagrams for the scandata's codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/scanpy/on_boarding.md

These diagrams are designed to help people quickly understand a codebase. A lot of scientists engage with the scanpy codebase and we want to reduce the time to get up-to-speed from hours to minutes. We believe that most people start with small improvements and componentes that they want to check, this is why we are generating a diagram. The diagram is designed to give people context of the full system and then they can dive deeper into the component of interest. I'd love to hear where do you stand on this and if such docs can be part of your on-boarding procedure.

Any feedback is more than welcome! We've just released a free GitHub Action that can automatically update the diagrams and this way keep them always up-to-date.

Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.

Just a note I did a PR in another repo of yours a while back, but it became a bit outdated with our new versions so I closed it: scverse/anndata#2010

  • Closes #
  • Tests included or not required because:
  • Release notes not necessary because:

@ivanmilevtues ivanmilevtues changed the title Added high-level diagrams [Docs] Visualizing scanpy's codebase Jul 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant