Skip to content

docs(config): describe holidays API and retrospective theme flags - #18

Merged
joeldickson merged 1 commit into
ShipLean:mainfrom
jdotc1:docs/holidays-retro-config-20261102
Nov 4, 2026
Merged

joeldickson merged 1 commit into
ShipLean:mainfrom
jdotc1:docs/holidays-retro-config-20261102

Conversation

@jdotc1

@jdotc1 jdotc1 commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document SHIPLEAN_HOLIDAYS_API_URL: the Nager.Date base URL, mirror configuration, and the empty-string opt-out for offline installations.
  • Document the experimental SHIPLEAN_RETRO_AUTO_THEMES toggle, its off default and embedding-model requirement without promising clustering accuracy.
  • Link the Public holidays project-settings guide to the new configuration reference.

These settings exist in the product README but were missing from the docs configuration page. Documentation only; no runtime changes.

Closes #12.

Validation

  • node scripts/check-config.ts ../ShipLean__ShipLean/README.md — passed in the prepared checkout.
  • pnpm check — passed.
  • pnpm build — passed (52 pages generated).
  • pnpm check:site — not completed in this environment because the site checker requires restricted external network access.

Document the supported runtime settings and link the holidays guide
back to the configuration reference.

Refs ShipLean#12
@joeldickson
joeldickson merged commit a9226dd into ShipLean:main Nov 4, 2026
3 of 4 checks passed
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.

Add SHIPLEAN_HOLIDAYS_API_URL and SHIPLEAN_RETRO_AUTO_THEMES to the configuration page

2 participants