Skip to content

chore: docs update - #27

Merged
pwlmc merged 2 commits into
mainfrom
pwlmc/docs-update
Mar 7, 2026
Merged

pwlmc merged 2 commits into
mainfrom
pwlmc/docs-update

Conversation

@pwlmc

@pwlmc pwlmc commented Mar 7, 2026

Copy link
Copy Markdown
Owner
  • Adds video from Riga meetup to the Getting Started section
  • Updates the Getting Started section with cards for each effect to make it easier to scan the page
  • The main README now links to new documentation pages (previously md files)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the project’s documentation entry points by refreshing the docs landing page and pointing the main README’s effect links at the published docs site.

Changes:

  • Reworks docs/index.md with a new hero section, embedded Riga meetup video, and “effect card” layout.
  • Simplifies the Getting Started examples into short per-effect snippets.
  • Updates README effect links to use the GitHub Pages documentation URLs instead of local docs/*.md files.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
docs/index.md Adds hero/video and introduces “effect cards” + page-local CSS for the Getting Started experience.
README.md Switches effect links from local markdown files to published docs-site URLs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/index.md Outdated
Comment thread docs/index.md
Comment thread docs/index.md
Comment thread docs/index.md Outdated
Comment thread docs/index.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/index.md Outdated
@pwlmc
pwlmc force-pushed the pwlmc/docs-update branch from 2fc5547 to aa6159d Compare March 7, 2026 09:34
@pwlmc
pwlmc merged commit 9060246 into main Mar 7, 2026
5 checks passed
@pwlmc
pwlmc deleted the pwlmc/docs-update branch March 7, 2026 09:35
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