This is a placeholder page that shows you how to use this template site.
This section is where the user documentation for your project lives - all the
information your users need to understand and successfully use your project.
For large documentation sets we recommend adding content under the headings in
this section, though if some or all of them don’t apply to your project feel
free to remove them or add your own. You can see an example of a smaller Docsy
documentation site in the Docsy User Guide, which
lives in the Docsy theme
repo if you’d like to
copy its docs section.
Other content such as marketing material, case studies, and community updates
should live in the About and Community pages.
Find out how to use the Docsy theme in the Docsy User
Guide. You can learn more about how to organize your
documentation (and how we organized this site) in Organizing Your
Content.
1 - Overview
Here’s where your user finds out if your project is for them.
This is a placeholder page that shows you how to use this template site.
The Overview is where your users find out about your project. Depending on the
size of your docset, you can have a separate overview page (like this one) or
put your overview contents in the Documentation landing page (like in the Docsy
User Guide).
Try answering these questions for your user in this page:
What is it?
Introduce your project, including what it does or lets you do, why you would use
it, and its primary goal (and how it achieves it). This should be similar to
your README description, though you can go into a little more detail here if you
want.
Why do I want it?
Help your user know if your project will help them. Useful information can
include:
What is it good for?: What types of problems does your project solve? What
are the benefits of using it?
What is it not good for?: For example, point out situations that might
intuitively seem suited for your project, but aren’t for some reason. Also
mention known limitations, scaling issues, or anything else that might let
your users know if the project is not for them.
What is it not yet good for?: Highlight any useful features that are
coming soon.
Where should I go next?
Give your users next steps from the Overview. For example:
What does your user need to know to try your project?
This is a placeholder page that shows you how to use this template site.
Information in this section helps your user try your project themselves.
What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.
Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.
Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.
Prerequisites
Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?
Installation
Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?
Setup
Is there any initial setup users need to do after installation to try your project?
Try it out!
Can your users test their installation, for example by running a command or deploying a Hello World example?