Skip to content

Public-readiness (1/3): welcome-first README, reader guide, about doc - #71

Merged
jposluns merged 1 commit into
mainfrom
claude/public-readiness-docs
Jul 7, 2026
Merged

Public-readiness (1/3): welcome-first README, reader guide, about doc#71
jposluns merged 1 commit into
mainfrom
claude/public-readiness-docs

Conversation

@jposluns

@jposluns jposluns commented Jul 7, 2026

Copy link
Copy Markdown
Owner

First of a few PRs to make the repo welcoming for non-technical guests before it goes public.

Root README, rewritten for guests

Now opens with a short welcome and Blima's biscotti photo, then three clear paths:

  • Read the cookbook — download BlimaCake.epub (or via Releases) + link to the new install guide.
  • Browse the recipes — by category and by tag.
  • Why "BlimaCake"? — the origin story.
  • Rights and reuse — plain-language CC BY 4.0 + the takedown contact.

All the archival/technical material (WXR import, provenance, tools, roadmap, governance) moved out of the front page into a new doc so it stays available without confronting a casual reader.

New docs

  • docs/read-the-cookbook.md — step-by-step instructions for Apple Books, Kindle (Send to Kindle, verified current), Kobo, Google Play Books, and other readers, plus "what is an EPUB / where do I download it".
  • docs/about-this-archive.md — the moved-out "how this was made" content (scope, structure, provenance, curation, the e-book build, contributing/governance).

Also

  • NOTICE.md contact aligned to jeff@posluns.ca (matches the ebook and README).

Notes / still to come

  • Links use relative paths and inline-code for external URLs, so markdownlint and the link checker stay green; the guide references the Releases download, which I'll publish as a separate step.
  • PR 2 will make the generated indexes (recipes/README.md, category pages, tags.md) friendlier and add a navigation breadcrumb to every recipe page.
  • A scoped GitHub Pages site proposal will follow as its own document.

Dash-guard and markdownlint clean.

🤖 Generated with Claude Code


Generated by Claude Code

Rewrite the root README for non-technical guests: a short welcome with
Blima's biscotti, then clear paths to read the cookbook (download +
install guide), browse recipes (by category or tag), the BlimaCake
story, and plain-language rights. Move the technical/provenance/tooling
detail into docs/about-this-archive.md so it stays available without
crowding the front page. Add docs/read-the-cookbook.md, a step-by-step
guide to opening BlimaCake.epub on Apple Books, Kindle, Kobo, Google
Play Books, and other readers. Align the NOTICE contact to
jeff@posluns.ca.

Co-authored-by: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HpG2vky2XhDtfc6y16TRis
@jposluns
jposluns merged commit 2264cb5 into main Jul 7, 2026
4 checks passed
@jposluns
jposluns deleted the claude/public-readiness-docs branch July 7, 2026 13:51
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