Skip to content

Docs: move documentation to README - #7

Open
ohmyfelix wants to merge 3 commits into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme
Open

Docs: move documentation to README#7
ohmyfelix wants to merge 3 commits into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme

Conversation

@ohmyfelix

Copy link
Copy Markdown
Contributor

What changed

  • Moved the package documentation from .docs/README.md into the root README.md.
  • Removed the pointer-only documentation section and kept the existing .docs/assets image referenced from the root README.

Why

Testing

  • git diff --check
  • Targeted README scans for stale .docs/README.md, .docs index, and moved asset links.

Co-authored-by: Felix <rkfelix@gmail.com>
ohmyfelix and others added 2 commits July 7, 2026 17:04
Co-authored-by: Milan Sulc <rkfelix@gmail.com>
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