Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.81 KB

File metadata and controls

34 lines (24 loc) · 1.81 KB

al-folio Documentation

These guides cover the al-folio v1.x starter and its pluginized runtime.

User Guides

  • Quick Start: create a site from the template and get it live quickly.
  • Installing and Deploying: Docker, local setup, GitHub Pages, Netlify, and upgrade guidance.
  • Customizing: content, CVs, publications, layouts, local overrides, and feature configuration.
  • FAQ: common deployment, upgrade, plugin, and troubleshooting questions.
  • Troubleshooting: build, deployment, styling, and content debugging.
  • Analytics: analytics provider setup.
  • SEO: search-engine and social preview setup.

Maintainer Guides

v1 Plugin System

al-folio v1.x is a thin starter. It owns site wiring, example content, documentation, integration tests, and visual tests. Runtime behavior belongs in Ruby gems maintained under the al-org-dev organization.

When changing feature behavior, route the work to the owning plugin repo first. Update this starter only when the change affects:

  • Gemfile dependency pins,
  • _config.yml plugin activation or feature flags,
  • _data/featured_plugins.yml catalog metadata,
  • documentation, examples, integration tests, or visual parity coverage.

See Ownership Boundaries for the full routing table.