Skip to content

Docs: move documentation to README#38

Open
ohmyfelix wants to merge 1 commit into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme
Open

Docs: move documentation to README#38
ohmyfelix wants to merge 1 commit 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.
  • Kept the Contributte README badge/contact scaffold and added the package intro, Versions, Installation, and merged usage sections.
  • Updated template image links to work from the root README and removed the stale .docs documentation wrapper.

Why

Refs contributte/contributte#75.

Testing

  • git diff --check
  • Targeted README scans for stale .docs links, duplicate wrappers, anchors, and kept image assets.

Co-authored-by: Felix <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