Skip to content

Docs: fix GitHub Pages build and add related links - #41

Merged
novatechflow merged 1 commit into
mainfrom
docs-pages-build
Oct 18, 2026
Merged

novatechflow merged 1 commit into
mainfrom
docs-pages-build

Conversation

@novatechflow

Copy link
Copy Markdown
Member

The Pages build failed with a fatal Liquid exception: include_relative ../CHANGELOG.md in docs/changelog.md (and the same for CONTRIBUTING.md in docs/contributing.md). Jekyll does not allow .. in include paths, and the files live outside the ./docs source. Go and Helm template syntax produced Liquid warnings and would have rendered blank or broken code.

Changes:

  • Deploy Docs workflow copies CHANGELOG.md and CONTRIBUTING.md into docs/_includes before the build (git-ignored), and the two pages use {% include %}
  • docs/ARCHITECTURE.md, docs/DEPLOYMENT.md and docs/acceptance-protocol.md bodies are wrapped in raw tags, so {{.Version}}, Helm templates and ${{ secrets... }} render as written
  • docs/index.md uses plain relative links instead of {% link %}; jekyll-relative-links adds the /kshark-core base URL (the link tag on Jekyll 3.10 does not)
  • _config.yml: excludes Gemfile from the published site, adds a Scalytics open source aux link and footer links
  • index: short Related projects section (KafClaw, KafScale, kaf-mirror), source link and scalytics.io/open-source

Built locally with Jekyll 3.10.0 and just-the-docs v0.10.0: no Liquid warnings, all pages render, links resolve under /kshark-core, canonical URLs are https://scalytics.github.io/kshark-core/...

@novatechflow
novatechflow merged commit a6cade2 into main Oct 18, 2026
2 checks passed
@novatechflow
novatechflow deleted the docs-pages-build branch October 18, 2026 11:17
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