[Docs] Visualizing scanpy's codebase #3701
Open
+868
−0
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.
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