Automated pipeline / AI for documentation
Updated
12 days
ago.
1 hackers ♥️.
2 followers.
Description
We are all tired of writing documentation (although there are some that like it, you nerd!!!) so why not automate that tedious part of our work away with the help of AI. The goal of this project is to create a tool that is able to generate documentation based on the proposed changes (or a PR) from our existing repository and store that as a markdown file locally and then submitted as a PR to the repository.
Goals
Create a tool that is able to be run as part of the CI/CD pipeline to get the latest changes from a PR and output a markdown file, later to be submitted as a PR itself.
Resources
Phases
- Phase 1 - Core tool that is able to crawl our repository, changed code and it should be able to output a markdown file [Complete]
- Phase 2 - Integrate into a CI/CD to work with the PRs
- Phase 3 - Be able to modify documents in confluence directly.
Code:
Available in Data teams' repository (suse-it-bi)
Looking for hackers with the skills:
Nothing? Add some keywords!
This project is part of:
Hack Week 25
Activity
