Documentation

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.


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 July 3, 2019: Added links to user guide repo (d6aa89c)
https://example.docsy.dev/docs/
example.docsy.dev
crawl=CC-MAIN-2020-45
37944
application/http; msgtype=response
sha1:UUYDCX2YIHKC2E7HNYSDD52KSMC7A2I2
<urn:uuid:e5b88b6e-19c7-474e-861b-bf4f77118ee0>
2020-10-22T20:53:29Z
104.248.63.231
text/html
sha1:J426UCKMYSA4IVRYX3RCA6ES2X2QIC2N
<urn:uuid:fe91dd51-3fa7-4d5e-9ac7-67d5ff4a25c4>
https://example.docsy.dev/docs/
response
<urn:uuid:fbd5f684-e40b-47bd-a79c-c3afdd0c9b17>
isPartOf: CC-MAIN-2020-45
publisher: Common Crawl
description: Wide crawl of the web for October 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-174.ec2.internal
software: Apache Nutch 1.17 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/