Skip to content

docs: reorganize README and add a haiku about presentations - #130

Merged
KeeTraxx merged 1 commit into
mainfrom
plumberduck/readme-improve-haiku-1792273609
Oct 17, 2026
Merged

KeeTraxx merged 1 commit into
mainfrom
plumberduck/readme-improve-haiku-1792273609

Conversation

@plumberduck

@plumberduck plumberduck commented Oct 17, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #129

The README is regrouped by what users do: writing slides, presenting, custom styling, commands, exporting and publishing, and development. Some wording is tightened. No documented behavior changed. A short haiku about presentations is added at the end.

To verify, read the rendered README on this branch and run npm run format:check, which passes for README.md.

Summary by Sourcery

Reorganize and refine the README to make Presentomatic workflows easier to navigate, and add a presentation-themed haiku.

Enhancements:

  • Reorganize the README around common user workflows, including writing, presenting, styling, commands, exporting, publishing, and development.
  • Tighten README wording and clarify usage instructions without changing documented behavior.

Documentation:

  • Add a short presentation-themed haiku to the README.

Group the README by what users do (writing, presenting, styling, exporting, developing) and tighten some wording. Documented behavior is unchanged.
@sourcery-ai

sourcery-ai Bot commented Oct 17, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

README.md is reorganized by user workflow, with wording and section headings clarified while preserving documented behavior, and a presentation-themed haiku is added at the end.

File-Level Changes

Change Details Files
Reorganize the README around user workflows and clarify existing documentation without changing documented behavior.
  • Group presenting, custom styling, exporting and publishing, commands, and development content under clearer sections.
  • Tighten wording and improve explanations for the default server port, live reload behavior, and CSS customization.
  • Add an exporting and publishing section heading while retaining the existing command and PDF documentation.
README.md
Add a short presentation-themed haiku to the end of the README.
  • Add a Haiku section with a three-line poem about audience attention and slide pacing.
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#129 Improve the README’s structure and wording without changing documented behavior. ✅
#129 Add a short haiku about presentations at the end of the README. ❌ A three-line poem about presentations is added at the end, but its final line (“One clear idea, held.”) has six syllables, so the poem does not follow the usual 5-7-5 haiku form.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@KeeTraxx
KeeTraxx merged commit dadb34a into main Oct 17, 2026
3 checks passed
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.26.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve README and add a Haiku about presentations

2 participants