[Docs] update readme to include instructions to use npm link
Open
@yashodipmore is already working on this.
Since Jun 15, 2025.
area/docs
good first issue
help wanted
language/markdown
- Dominant language
- TypeScript
- Stars
- 137
- Forks
- 239
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 5
Description
Desired State
we'll need to specify instruction on how contributors can use npm link to quickly get their changes reflected, while building locally.
Contributor Guides and Resources
- 📚 Instructions for contributing to documentation
- 🛠 Meshery Build & Release Strategy
- 🎨Wireframes and designs for Sistent site in Figma (open invite)
- 🙋🏾🙋🏼 Questions: Layer5 Discussion Forum and Layer5 Community Slack
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.