Repository navigation
docs: reorganize README and add a haiku about presentations - #130
Merged
Merged
Conversation
Group the README by what users do (writing, presenting, styling, exporting, developing) and tighten some wording. Documented behavior is unchanged.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideREADME.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
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
🎉 This PR is included in version 2.26.7 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 forREADME.md.Summary by Sourcery
Reorganize and refine the README to make Presentomatic workflows easier to navigate, and add a presentation-themed haiku.
Enhancements:
Documentation: