docspackagediscord
luther
Writing documentation so you don't have to.
aboutget startedsource
What does luther do?
luther is a library and cli tool that holistically documents codebases using state-of-the-art AI. It takes pressure off of the developer and allows them to concentrate on the main task of writing software, while significantly decreasing onboarding time for contributors. On top of writing documentation, it can also check if existing documentation is out-of-date or incorrect.
How does luther work?
luther works by: 1. beginning at the code level, documenting the "what" and "how" of individual functions, recursing up to files and directories; 2. describing the purpose (the "why") of these elements, starting with a description of the application and recursing downwards; 3. asking itself questions about the codebase ("how can I start quickly using this", "how can I build this from source", etc.) Read more in our documentation, generated entirely by luther itself.
Why is there a pull request to add luther to my project?
That would be the work of luther's little lackey, or triple-L. triple-L is designed to actively find undocumented projects on GitHub above a certain number of stars and automatically write documentation and add luther to the project. Feel free to reject this PR, but note that luther is a completely free and secure software that operates with existing documentation. If you hate triple-L, please help by contributing to improve luther or posting feedback on the Discord server.