About the project
High-level information about the project, including its purpose, ownership, and overall status.
Oink project and website documentation
How the Oink theme and website are built, maintained, and deployed.
Content (planned)
Planned content organization (tentative):
- 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: Code-level structure and conventions, Hugo/Docsy templates, SCSS/JS customizations, patches, and internal shims.
- 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
Build
Tooling, local development setup, CI/CD workflows, deployment environments, and automation details.
Implementation
Code-level structure and conventions, Hugo/Docsy templates, SCSS/JS customizations, patches, and internal shims.
Project repositories
Source repositories for the Oink theme and project site.
Style guide
Writing and formatting conventions for Docsy project documentation.