Documentation on Enrique's Website

Overview

Mon, 01 Jan 0001 00:00:00 +0000

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:

Examples

Thu, 05 Jan 2017 00:00:00 +0000

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

Do you have any example applications or code for your users in your repo or elsewhere? Link to your examples here.

Concepts

Mon, 01 Jan 0001 00:00:00 +0000

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

For many projects, users may not need much information beyond the information in the Overview, so this section is optional. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.

Contribution Guidelines

Mon, 01 Jan 0001 00:00:00 +0000

These basic guidelines assume that your Docsy site is stored in GitHub and deployed with GitHub Pages. Adapt them with project-specific review guidelines, versioning guidelines, or any other information contributors need when updating the site. Kubeflow has a great example.

Make sure contributors can find these guidelines from the project README or the site navigation.

We use Hugo to format and generate our website, the Docsy theme for styling and site structure, and GitHub Pages to publish the site. Hugo is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.