Overviews

Overviews are high-level explanations of your project. They exist to orient the user as to what you are documenting and why it exists. This page also documents what a user will need to understand prior to using your tool or library. Link to the official documentation of language it is written in, as well as any dependencies users will need to use in conjunction with your project (such as databases your ORM framework can talk to).

Overviews also need to show the structure of the documentation, and give the user an idea as to what they're going to find in different parts of the documentation.

Checklist

• First sentence states what the project does or it's intended use
• Links to the "Getting Started" page
• Links to the technologies and standards you use in your project
• Links to useful documentation for what you use in your project
• Discusses the structure of the documentation - separate links to api docs, tutorials, etc