# Oink project and website documentation

> How the Oink theme and website are built, maintained, and deployed.

---

LLMS index: [llms.txt](/oink.pgsty.com/llms.txt)

---

<span class="badge bg-warning text-bg-warning fs-6">
<i class="fa-solid fa-person-digging text- pe-2 px-1"></i> Section under construction. <i class="fa-solid fa-person-digging text- ps-2 px-1"></i>
</span>

## Content (planned) {#content}

Planned content organization (tentative):

- [About](about/): High-level information about the project, including its
  purpose, ownership, and overall status.
- **Design**: Architectural design, Information Architecture (IA), layout, UX
  choices, theme related decisions, and other design-level artifacts.
- [Implementation](implementation/): Code-level structure and conventions,
  Hugo/Docsy templates, SCSS/JS customizations, patches, and internal shims.
- [Build](build/): Tooling, local development setup, CI/CD workflows, deployment
  environments, and automation details.
- **Quality**: Link checking, accessibility standards, tests, review practices,
  and other quality-related processes.
- **Roadmap**: Milestones, backlog, priorities, technical debt, and
  design/implementation decisions.

## Site build information

Oink version: `v0.16.1-dev+003-over-main-be0a08fe`

---

Section pages:

- [About the project](/oink.pgsty.com/zh/project/about/): High-level information about the project, including its purpose, ownership, and overall status.
- [Build](/oink.pgsty.com/zh/project/build/): Tooling, local development setup, CI/CD workflows, deployment environments, and automation details.
- [Implementation](/oink.pgsty.com/zh/project/implementation/): Code-level structure and conventions, Hugo/Docsy templates, SCSS/JS customizations, patches, and internal shims.
- [Project repositories](/oink.pgsty.com/zh/project/repo/): Source repositories for the Oink theme and project site.
- [Style guide](/oink.pgsty.com/zh/project/style-guide/): Writing and formatting conventions for Docsy project documentation.