Skip to content

[Docs]Centralize contributing docs and highlight Schema-Driven Development #571

@1012Charan

Description

@1012Charan

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

  1. Slim down README.md - Remove duplicated content, link to comprehensive docs
  2. Consolidate content in CONTRIBUTING.md - Merge all detailed info (naming conventions, code generation, RTK usage)
  3. Add SDD notes to AGENTS.md and build/README.md - Ensure all entry points highlight schema-driven development
  4. Make SDD statement prominent - Bold the key statement in all files

Contributor Guides and Handbook

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions