Skip to content

v4 docs: user-facing documentation still presents jBake as the site-generation engine #47

Description

@raifdmueller

Problem

With #45 and #46 merged into main-4.x, the v4 microsite is rendered by the built-in MicrositeBaker (scripts/lib/MicrositeBaker.groovy) — jBake (and its OrientDB content store) has been removed from the runtime. The user-facing documentation has not caught up: several pages still tell readers that generateSite uses jBake as its engine.

This is misleading now: there is no jBake dependency to install, configure, or read jBake docs for. What stays is the :jbake-*: metadata header format — MicrositeBaker deliberately reads jBake-compatible headers for backwards compatibility, so that part of the docs is still correct and should be preserved.

Scope

Update (still describe jBake as the engine):

  • src/docs/015_tasks/03_task_generateSite.adoc — "uses jBake to create a static site", "The jBake templates …".
  • src/docs/020_tutorial/040_microsite/043_multi-markup.adoc — "leverages jBake", the "==== jBake" section, "jBake employs flexmark", links into jbake.org docs.

Polish (architecture should name the real component):

  • arc42 Ch5 building-block view + Ch8 concepts already describe a "custom SSG replacing jBake" — name MicrositeBaker and its source location scripts/lib/MicrositeBaker.groovy (per our arc42 contract: each building block states responsibility, interface, and source location).
  • ADR-04 status: reflect that the decision is now implemented in v4.0.

Explicitly keep / out of scope:

  • The :jbake-*: metadata header format and the ~~~~~~ header block — these remain the documented contract (jBake-compatible).
  • Historical news/release notes under src/docs/030_news/** — these are a record, not current docs.
  • Java-version docs ("Java 17") — the dtcw4 wrapper still requires Java 17 (dtcw4:60); the Groovy 4 runtime can run on 21 but the wrapper gate (separate change) is not merged, so the current docs are accurate.

A detailed file:line analysis and the concrete edit plan follow as a comment.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions