Skip to content

TaheraAhmed/docusync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocuSync — LLM-Assisted Documentation

Automates product documentation from codebase & release metadata with an LLM + CI/CD.

<ALT TEXT GOES HERE>

1) Problem

Manual doc writing slowed releases and produced inconsistencies.

2) Approach

  • Parse release metadata + code diffs
  • Generate draft docs via LLM (OpenAI API)
  • Human-in-the-loop review in PR
  • CI/CD integration to trigger suggestions

3) Results

  • -70% manual doc effort
  • faster turnaround
  • Better cross-team visibility

4) How to Run (local)

pip install -r requirements.txt
export OPENAI_API_KEY=...
python src/generate_docs.py --release_notes path/to/notes.md

Python Status License: MIT

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors