About the project on Docsy

ReadMe

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

Docsy

Docsy is a Hugo theme for technical documentation sets, providing simple navigation, site structure, and more.

This is not an officially supported Google product. This project is actively being maintained.

🚧 IMPORTANT 🚧

The main branch is under development and not officially supported; use official Docsy releases. For full support details, see Official support limits.

Prerequisites

The following are basic prerequisites for using Docsy in your site:

Changelog

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

We only document breaking changes and release highlights in this page. For the full list of changes of any particular release, see the release notes.

Useful links: Releases & tags, jump to the latest release, and view the milestones.

Style guide

Use past tense when when describing releases.
Generally, start each change entry with a verb (in the past tense). For example: Added, Changed, Deprecated, Fixed.
It’s ok to follow that with “you can now…”. For example:

Feature abc: you can now…".

Maintainer notes

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

For our main contributing page covering license agreements, code of conduct and more, see Contributing. This page is for maintainers only.

Publishing a release

These notes are WIP for creating a release from a local copy of the repo. These instructions assume the release is v0.14.4-dev, if not adjust accordingly.

Change directory to your local Docsy repo.
Create or update a changelog entry for v0.14.4-dev.
- The section should provide a brief summary of breaking changes using the section template at the end of the file.
- Ensure to remove the UNRELEASED note, if still present.
- You’ll create a new section for the next release in a later step.
Update the release report blog post for v0.14.4-dev, if any.