Skip to content

Add Bakery documentation site via GitHub Pages#402

Merged
bschwedler merged 30 commits into
mainfrom
feature/github-pages
Apr 10, 2026
Merged

Add Bakery documentation site via GitHub Pages#402
bschwedler merged 30 commits into
mainfrom
feature/github-pages

Conversation

@ianpittwood
Copy link
Copy Markdown
Contributor

@ianpittwood ianpittwood commented Mar 26, 2026

Summary

  • configuration.qmd: Fixed 5 typos (depencency, calcuated, strin gs, registrie s, f no), repaired broken GossOptions table column alignment, corrected misleading DependencyConstraint/DependencyVersions descriptions, documented the prerelease field, aligned inconsistent subpath examples
  • templating.qmd: Fixed broken source code link, removed redundant manual TOC, documented Image.IsDevelopmentVersion variable, clarified Image.OS.Family values, added Custom Jinja2 Filters section (quote, split), documented python.declare_build_arg() macro, clarified requirements_file/requirements_files parameter naming
  • index.qmd: Removed unimplemented tools (hadolint, trivy, wizcli, openscap) from prerequisites table, deduplicated docker buildx bake from prerequisites list
  • architecture.qmd: Added introductory prose explaining diagram conventions, added status note to Publish section

Test plan

  • Verify rendered docs at localhost with just docs-preview — check all four pages render correctly
  • Confirm no broken internal links between pages
  • Verify Mermaid diagrams still render on architecture page
  • Check new Custom Jinja2 Filters section appears in templating page sidebar TOC

🤖 Generated with Claude Code

@ianpittwood ianpittwood force-pushed the feature/github-pages branch from 94a4ee8 to 84b50f7 Compare March 26, 2026 19:08
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 26, 2026

Test Results

1 277 tests  ±0   1 277 ✅ ±0   8m 49s ⏱️ +25s
    1 suites ±0       0 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit a238224. ± Comparison against base commit 291e13d.

♻️ This comment has been updated with latest results.

@ianpittwood ianpittwood force-pushed the feature/github-pages branch from 4f4f8a9 to 5f03e25 Compare March 26, 2026 21:40
ianpittwood and others added 22 commits March 31, 2026 12:28
Quarto-based docs site using posit-dev/product-doc-theme, migrating
existing markdown docs into posit-bakery/docs/ and slimming the README.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
9-task plan covering Quarto scaffolding, content migration, README
slimdown, local verification, and GitHub Actions deployment.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Move the bakery.yaml configuration reference from standalone markdown
into the Quarto documentation site as configuration.qmd. Update internal
cross-references to point to sibling .qmd files.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Without an explicit render list, `quarto render` discovers 0 files
in the posit-docs project type and produces an empty _site/.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a custom KDE syntax definition for Jinja2 templates that highlights
expressions ({{ }}), statements ({% %}), comments ({# #}), Dockerfile
keywords, and shell variables.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Distinguish function calls (setup(), build_stage()), object names
(apt, python, Dependencies), delimiters ({{ }}), operators, and
identifiers with separate highlight styles.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add explicit white text color to tooling and external class definitions
so node labels are readable against blue and grey backgrounds.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…iguration docs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…mplating docs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ing Started

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ianpittwood ianpittwood force-pushed the feature/github-pages branch from 4bcdf16 to fb4d33f Compare March 31, 2026 18:29
@ianpittwood ianpittwood force-pushed the feature/github-pages branch from d3c2165 to 47b1ea5 Compare March 31, 2026 18:50
@ianpittwood ianpittwood force-pushed the feature/github-pages branch from 47b1ea5 to 40670d2 Compare March 31, 2026 18:51
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI this was written by Claude. No Jinja2 KDE definition currently exists.

Comment thread posit-bakery/docs/index.qmd
@ianpittwood ianpittwood marked this pull request as ready for review April 2, 2026 13:52
@ianpittwood ianpittwood requested a review from bschwedler as a code owner April 2, 2026 13:52
ianpittwood and others added 2 commits April 2, 2026 10:10
The glightbox wrapper added by mermaid-lightbox defaults to inline-block,
constraining SVG diagram width. Override to block/100% so diagrams fill
their container.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@bschwedler bschwedler enabled auto-merge April 10, 2026 17:55
@bschwedler bschwedler added this pull request to the merge queue Apr 10, 2026
Merged via the queue into main with commit 6a85b68 Apr 10, 2026
16 checks passed
@bschwedler bschwedler deleted the feature/github-pages branch April 10, 2026 18:20
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.

2 participants