-
Notifications
You must be signed in to change notification settings - Fork 107
[Docs]Centralize contributing docs and highlight Schema-Driven Development #571
Copy link
Copy link
Open
Labels
area/docsImprovements or additions to documentationImprovements or additions to documentationframework/jekylllanguage/markdown
Description
Description
Meshery follows schema-driven development, but this philosophy is not prominently highlighted across all contributing guides in the schemas repository. Contributors landing on different documentation pages may not immediately understand the importance of schemas in Meshery's architecture.
Current State
- README.md has detailed content that duplicates what's already in Meshery Docs
- CONTRIBUTING.md lacks some content that was in README
- AGENTS.md and build/README.md don't reference schema-driven development
Proposed Changes
- Slim down README.md - Remove duplicated content, link to comprehensive docs
- Consolidate content in CONTRIBUTING.md - Merge all detailed info (naming conventions, code generation, RTK usage)
- Add SDD notes to AGENTS.md and build/README.md - Ensure all entry points highlight schema-driven development
- Make SDD statement prominent - Bold the key statement in all files
Contributor Guides and Handbook
- 📚 Instructions for contributing to documentation
- 🛠 Meshery Build & Release Strategy
- 🎨 Wireframes and designs for Meshery UI in Figma (open invite)
- 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area/docsImprovements or additions to documentationImprovements or additions to documentationframework/jekylllanguage/markdown