documentation

Documentation

A mostly reasonable approach to documentation.

1. Basic Rules
2. Formatting

Basic Rules

Prefer to store and reference local assets

When possible store static assets in the .assets folder; not only is it faster but there is no dependency on the external hosting.

DO:

![Development Guide](./docs/.assets/project-title.png)

DON'T:

![Development Guide](https://i.imgur.com/EpXBaDQ.jpg)

Formatting

Repository README

# {Repository Title}

[![{BADGE_TITLE}]({BADGE_LINK})]({URL})

_{SHORT_DESCRIPTION}_

![{TITLE}](./docs/.assets/project-title.png)

![{SCREENSHOT}](./docs/.assets/project-screenshot.png)

1. Repository Title
2. Badges
3. Short Description
4. Project Title Image
   • Prefer to use an asset exported from assets/project-title.
5. Project Screenshot Image
   • Prefer to use an asset exported from assets/project-screenshot.
6. Content (as relevant)
   • Examples include: Getting Started, Installation, Usage, Contribution...etc