About the project on OINK

ReadMe

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

Oink is a local-first Hugo theme for engineering documentation. It ships its styles, fonts, search, diagrams, API documentation runtimes, and content components with the theme, so consuming sites need only Hugo Extended, Go, and Git.

Read the current theme README for installation instructions, requirements, and attribution.

Changelog

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

We document breaking changes and release highlights in this page, with maintainer-facing changes summarized at the end of each release section. 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.

Important

This page preserves detailed upstream Docsy monorepo procedures for historical reference. Oink now uses separate theme and project-site repositories. Follow Git repository layout and branch model and the current Oink release process for repository paths, module tags, validation, and publication.

Content placement

Keep project content DRY by writing each fact in the artifact whose purpose and audience it serves. Each artifact links to the more detailed ones rather than restating them: