Skip to content

docs: rewrite README, drop animated banners and fix staleness - #19

Merged
zaccesss merged 1 commit into
mainfrom
docs/rewrite-readme
Aug 5, 2026
Merged

docs: rewrite README, drop animated banners and fix staleness#19
zaccesss merged 1 commit into
mainfrom
docs/rewrite-readme

Conversation

@zaccesss

@zaccesss zaccesss commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Rewrites README.md to drop the animated capsule-render waving banners and the readme-typing-svg animated typing banner, which are no longer wanted in this repo.

While rewriting, this also fixes:

  • The duplicate "Links" and "Contact and Support" sections, merged into one "About and contact" section.
  • The contradiction between CHANGELOG.md (Avatar upload support listed under Unreleased) and ROADMAP.md (avatar upload marked Complete) and the README's own feature list (already describing profile picture upload as shipped). CHANGELOG.md is updated to drop the stale unreleased line and a new entry documents the README rewrite.

Kept as is: the static tech stack icon table (devicon and techstack-generator badges), since that is a style choice rather than an animation.

Every link and embedded image in the new README was checked and resolves.

Closes #18

Removes the capsule-render waving banners and readme-typing-svg
animated text banner. Merges the duplicate Links and Contact and
Support sections into one. Reconciles CHANGELOG.md with
ROADMAP.md so avatar upload is no longer listed as unreleased
when it shipped in v2.0.0.

Closes #18
@zaccesss zaccesss added documentation Improvements or additions to documentation chore Housekeeping quick-win Small and high value, do in a spare moment autoclose Close this issue when a PR that references it merges labels Aug 5, 2026

@zaccesss zaccesss left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Checked before merging:

  • Every badge, embedded image and link in the new README resolves (verified with curl against the shields.io badges, the devicon and techstack-generator icons, the workflow status badge, the live site links and the contact links).
  • No more animated capsule-render or typing-svg banners anywhere in the file.
  • No duplicate sections: Links and Contact and Support are now one "About and contact" section.
  • CHANGELOG.md and ROADMAP.md now agree that avatar upload shipped in v2.0.0, matching what the README already described as a live feature.
  • CI (PHP syntax check, CodeQL, Analyze) all pass on a README-only and CHANGELOG-only change, as expected.

Merging with squash.

@zaccesss
zaccesss merged commit e8e6dd9 into main Aug 5, 2026
3 checks passed
@zaccesss
zaccesss deleted the docs/rewrite-readme branch August 5, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autoclose Close this issue when a PR that references it merges chore Housekeeping documentation Improvements or additions to documentation quick-win Small and high value, do in a spare moment

Development

Successfully merging this pull request may close these issues.

README still uses animated capsule-render and typing-svg banners

1 participant