Skip to content

docs: add example sites - #14

Merged
Jalkhov merged 2 commits into
stablefrom
docs/examples
Nov 8, 2026
Merged

Jalkhov merged 2 commits into
stablefrom
docs/examples

Conversation

@Jalkhov

@Jalkhov Jalkhov commented Nov 8, 2026

Copy link
Copy Markdown
Member

What

  • Add examples/minimal, examples/blog, examples/atlas and examples/handbook
  • Add examples/README.md with the index and how to build them
  • Add an examples CI job that builds each site with --clean

Why

The examples are the fastest way to see what the engine can do, and building them in CI stops them from rotting as the engine changes.

Notes

  • Examples are outside the wheel; they are not installed with the package.
  • atlas uses a local theme and overrides; handbook shows a configurable sidebar and footer driven by [extra].

- Add minimal, blog, atlas and handbook sites under examples/
- Keep them out of the wheel; they exist to show what the engine can do
- Each site is standalone and builds with `jamstack build`
- Build every example with `--clean` to catch template and config
  regressions
@Jalkhov
Jalkhov merged commit 33af81c into stable Nov 8, 2026
10 checks passed
@Jalkhov
Jalkhov deleted the docs/examples branch November 8, 2026 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant