Skip to content

📖 Move examples above API contract and simplify example notes - #27

Merged
gepser merged 1 commit into
masterfrom
feature/readme-examples-first
Feb 23, 2026
Merged

📖 Move examples above API contract and simplify example notes#27
gepser merged 1 commit into
masterfrom
feature/readme-examples-first

Conversation

@gepser

@gepser gepser commented Feb 23, 2026

Copy link
Copy Markdown
Owner

✨ What changed

  • Moved ## ✨ Examples above ## 📜 API Contract so readers see value sooner.
  • Simplified all example notes by removing URL: and Markdown: labels.
  • Kept only the concise copy-paste Markdown snippet inside each [!NOTE] block.

🎯 Why

This makes the README more engaging at the top and reduces visual noise in the examples section.

🧪 Validation

  • Verified README structure and content manually.
  • No runtime or API behavior changes (docs-only).

@gepser
gepser merged commit aaf4f1d into master Feb 23, 2026
2 checks passed
@gepser
gepser deleted the feature/readme-examples-first branch February 23, 2026 11:44
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.

1 participant