Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[TASK] Standardize README documentation across all packages #33623

@fmontes

Description

@fmontes

Description

Standardize README documentation format and content across all packages in the repository to improve consistency and maintainability.

This task involves updating README files across the root, core-web, examples, and other packages to ensure:

  • Standardized section naming (Support, Contributing, Licensing)
  • Consistent ordering of sections across all packages
  • Unified support channel listings with Enterprise Support details
  • Consistent licensing section formatting

The goal is to make documentation easier to navigate and maintain while providing a professional, cohesive experience across all package documentation.

Acceptance Criteria

  • All README files use consistent section naming: "Support", "Contributing", "License/Licensing"
  • Section ordering is standardized across all packages (Title/Description → Features → Installation → Usage → Configuration → Contributing → Support → License)
  • Support sections include unified content: Community channels, Professional Services, Enterprise Support with contact info
  • License sections have identical formatting with consistent badge placement and copyright format

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions