8000 docs: rewrite the READMEs for users and fill gaps in the skills by morellodev · Pull Request #318 · awesome-reveal/awesome-reveal · GitHub
[go: up one dir, main page]
Skip to content

docs: rewrite the READMEs for users and fill gaps in the skills - #318

Merged
morellodev merged 1 commit into
nextfrom
docs/rewrite-readmes
Oct 17, 2026
Merged

docs: rewrite the READMEs for users and fill gaps in the skills#318
morellodev merged 1 commit into
nextfrom
docs/rewrite-readmes

Conversation

@morellodev
@morellodev morellodev commented Oct 17, 2026 •
edited
Loading
Copy link
Copy Markdown
Collaborator

Summary

This PR rewrites all READMEs for the end user, and adds a preview notice for the 1.0 prerelease. It also fills the gaps that a check of the consumer skills against the source found:

  • Give explicit values to the first keyframe (all adding-reveal-animations skills).
  • Hydrate reveal content eagerly, because the stylesheet holds the server markup for at most 5 seconds (React, Vue).
  • when: true still renders the server markup hidden (Vue, Astro).
  • The Astro host revealed property and closest("awesome-reveal").
  • A template example in the Vue and Astro skills, so that agents do not copy render functions.

Checklist

  • The PR targets the next branch.
  • The PR title follows Conventional Commits. A breaking change has ! and a BREAKING CHANGE: footer.
  • Tests cover the change. This does not apply: the change is docs only. pnpm test:package type-checks the ts and tsx fences, and I checked the vue fences with vue-tsc.
  • A change to an option, a default or an export also updates the READMEs, the consumer skills and the examples.

@morellodev
morellodev commented Oct 17, 2026
Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector
chatgpt-codex-connector Bot commented Oct 17, 2026 •
edited
Loading
Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-17T13:02:14.529272Z 6ed0939 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@morellodev
morellodev force-pushed the docs/rewrite-readmes branc 8000 h from 6ed0939 to 926e1d6 Compare October 17, 2026 12:52
@chatgpt-codex-connector
chatgpt-codex-connector Bot commented Oct 17, 2026
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Hooray!

Reviewed commit: 6ed0939129

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@morellodev
morellodev merged commit ea0353c into next Oct 17, 2026
18 checks passed
@morellodev
morellodev deleted the docs/rewrite-readmes branch October 17, 2026 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@morellodev
0