docs: restructure READMEs, add CONTRIBUTING and LICENCE#107
Open
rin-st wants to merge 1 commit into
Open
Conversation
- Root README: overview + package list + quick start, no more dev instructions - New CONTRIBUTING.md absorbs local dev workflows (example app + Scaffold-ETH 2) - Slim package READMEs to install (npm/yarn/pnpm) + minimal example + docs link - New /debug-contracts installation page in the docs site, wired into sidebar - Add MIT LICENCE at root and license field on published packages - Replace example/README.md create-next-app boilerplate Closes #30 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #30. Pass over READMEs, contributing guide, and LICENCE.
/debug-contractsinstallation page mirroring/componentsand/hooks, wired into the sidebar and the landing page.BuidlGuidlattribution andLICENCEspelling). Added"license": "MIT"to all three published packages'package.jsonand a patch-bump changeset for it.Test plan
pnpm installandpnpm devstill work (no behavioral changes, just metadata)cd docs && pnpm dev—/debug-contractsrenders the new installation page; sidebar shows the new entryBuidlGuidlis the right copyright holder