Skip to content

about_docs.md

Latest commit

 

History

History
21 lines (19 loc) · 2.84 KB

about_docs.md

File metadata and controls

21 lines (19 loc) · 2.84 KB

Documentation templates 📚

These documentation templates are provided as a starting point for your CLI documentation. It's recommended to move these files accordingly, nevertheless it's strongly encouraged to keep a concise documentation structure, keeping the README.md simple, concise, and store the more detailed documentation in the docs folder. It includes the following files:

  • README.md with a standard structure for a CLI repository.
  • INSTALLATION.md file with the installation instructions for your CLI.
  • CONTRIBUTING.md file with the instructions for contributing to your CLI.
  • CODE_OF_CONDUCT.md file with the code of conduct for your CLI.
  • LICENSE.md file with the license for your CLI.

NOTE: It's recommended to move these files accordingly. However, normally a patter where the most detailed documentation is stored in the docs folder is used.

Templates

Currently, these are the templates available:

Name Description
CODE_OF_CONDUCT.md Code of conduct for your CLI.
CONTRIBUTING.md Contributing to your CLI.
INSTALLATION.md Installation instructions.
LICENSE.md License for your CLI. Ensure you're aware about the different type of licenses.
README.md README for your CLI.