Documentation

1 minute read

This is a placeholder page that shows you how to use this template site.

  1. For Rmarkdown integrations and new features, read Rmarkdown section
  2. This template is provided by docsy. You can use this similar structure to build to docs.

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.

Overview

Here’s where your user finds out if your project is for them.

Getting Started

What does your user need to know to try your project?

Examples

See your project in action!

Concepts

What does your user need to understand about your project in order to use it - or potentially contribute to it?

Core Tasks

What can your user do with your project?

Tutorials

Show your user how to work through some end to end examples.

Reference

Low level reference docs for your project.

Contribution Guidelines

How to contribute to the docs


Last modified 2021-07-24 : pg_build (fae2843)