Skip to content

docs: CHANGELOG + GitHub Pages landing + repo metadata polish#8

Merged
hculap merged 1 commit into
mainfrom
chore/v0.1.10-changelog-pages
May 19, 2026
Merged

docs: CHANGELOG + GitHub Pages landing + repo metadata polish#8
hculap merged 1 commit into
mainfrom
chore/v0.1.10-changelog-pages

Conversation

@hculap
Copy link
Copy Markdown
Owner

@hculap hculap commented May 19, 2026

Why

Two things missing from the repo:

  1. A single source of truth for what shipped when (`CHANGELOG.md` — GH Release notes scatter across 9 releases now)
  2. A user-facing landing page (`https://hculap.github.io/emodul/\`) that's friendlier than the README for non-developer audiences (Polish heating users finding us via search, Reddit / HA community drive-by clicks)

What

  • `CHANGELOG.md` — Keep-a-Changelog format, 0.1.0 → 0.1.9. Linked from README header.
  • `docs/` — Jekyll cayman theme (zero-build, supported natively by GH Pages). `docs/index.md` is a Polish-first landing covering: what emodul is, install snippet, three runtime paths, example PL queries, security notes, vs-HA-integration comparison. Ready to ship as soon as you enable Pages in Settings.
  • README header: PyPI badge + quick-link strip (landing · changelog · PyPI · AGENT.md)
  • Repo metadata (applied separately via `gh repo edit`):
    • Description rewritten to lead with MCP integration
    • Homepage URL → https://hculap.github.io/emodul/
    • Topics: dropped 5 low-signal tags, added `mcp`, `mcp-server`, `model-context-protocol`, `claude-desktop`, `cursor-ide`

After merge

You need to enable Pages once (30s):

  1. https://github.com/hculap/emodul/settings/pages
  2. Source: Deploy from a branch → Branch: `main` → Folder: `/docs`
  3. Save. GitHub builds the site, URL appears at the top of that settings page.

That's it. Subsequent updates just push to `main` and the site auto-rebuilds in ~1 min.

No code changes

Pure docs / metadata PR. No version bump, no PyPI publish, no breaking changes.

- CHANGELOG.md consolidates GH Release notes for 0.1.0..0.1.9 in one
  place (Keep a Changelog format). Linked from README header.
- docs/index.md + docs/_config.yml — Polish-first landing page rendered
  via Jekyll cayman theme. Covers: what emodul is, three install paths
  (MCP / CLI-agent / sandbox), example Polish-language queries, security
  notes, vs-HA-integration comparison. Ready for enable in Settings →
  Pages → Source: main /docs.
- README header gains a PyPI badge + a quick-link strip pointing at the
  landing page, CHANGELOG, PyPI, and AGENT.md so first-time visitors can
  navigate without reading the whole README.

Repo metadata refreshed via `gh repo edit` separately:
- Description rewritten to lead with MCP integration angle
- Homepage URL set to https://hculap.github.io/emodul/
- Topics: dropped 5 low-signal tags (reverse-engineering, python-cli,
  iot, floor-heating, poland), added mcp / mcp-server /
  model-context-protocol / claude-desktop / cursor-ide for
  AI-tooling-search discovery.
@hculap hculap merged commit 49d1a6a into main May 19, 2026
9 checks passed
@hculap hculap deleted the chore/v0.1.10-changelog-pages branch May 19, 2026 15:02
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