library-plus-doc-template

What problem does it solve?

Prevents libraries from becoming a repository of unexplainable tools by mandating a detailed companion documentation for each entry.

Core Features & Use Cases

• Documentation Pairing: Requires each library entry to be accompanied by a doc explaining its purpose, use case, and the rationale behind it.
• Library Curation: Supports library maintainers and future contributors by providing clear instructions and historical context.
• Use Case: For every new script added to a library, create a corresponding document that details the script's function, the moment that prompted its creation, and how to use it.

Quick Start

Pair a documentation for the new script 'cleanup.py' with the library entry using the library-plus-doc-template.