Skip to content

Conversation

@ivanmilevtues
Copy link

Description

I am adding high-level diagram driven documentation for the target-python-sdk project. You can see how they render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/target-python-sdk/on_boarding.md

Related Issue

Motivation and Context

Me and a friend are working on automatically generating documentaiton so that people can get up-to-speed with new codebases. We believe that visualizaiton is the best way to go, and as we know how tedious is to keep up-to-date docs we are generating them leveraging static analysis and LLMs.

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.

How Has This Been Tested?

Screenshots (if appropriate):

You can see how the diagrams look here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/target-python-sdk/on_boarding.md

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

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