High-level diagram visualization of the dropbox-sdk-python codebase #515
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 introduces markdown (mermaid) documentation in order for new people to get up-to-speed faster. You can see how the docs render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/dropbox-sdk-python/on_boarding.md
The idea behind the change is to help people get up-to-speed with the codebase faster and more asynchroniously. I would love to hear what is the current process in dropbox for on-boarding, what do you think of diagram first documentation and in what ways we might be able to help to improve the process!
The way the generation works at the moment is via Static Analysis and LLMs. The idea is that people can generate a new one as often as there are changes and so you get always up-to-date docs.
Any sort of feedback is more than welcome, especially on the quality of the diagrams!
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.
Checklist
General Contributing
Is This a Code Change?
Validation
tox
pass?