docs-for-me

docs-for-me is a Python CLI that creates programmer-friendly guides for files, folders, and Git changes.

The project

Built to make complicated work feel clear.

docs-for-me is a Python CLI that creates programmer-friendly guides for files, folders, and Git changes.

Inside the product

Features designed around the work.

Feature 01

The V1 - CLI Terminal

Docs for me wasn't supposed to be a fancy system with interface, it was meant to be a tool that can only be ran through terminal of a project.

Feature 02

Changes Result

When the system reviewed the changes, it will produce a ready to copy markdown that can be used for References of what was changed in your repository, or you can also use docs for me to just copy the commit message

Feature 03

Change Map

Change map is where docs-for-me identifies the use of a certain file, what does it do? how many lines does that file has? how many lines were removed? how many lines were added? How confident is the system based on the findings.

Feature 04

Ollama as the Local AI

As a programmer I don't want to heavily rely just on the system itself, what if we can improve the message? the findings? that's why I implemented using Local Ai where it can enhance its capabilities and to ensure accurate results when giving it to the user