Skip to content

docs: simplify README and add schema-based USERGUIDE#133

Merged
mike-dubman merged 2 commits intoMellanox:masterfrom
mike-dubman:feature/readme-rework-ci-usage
Feb 20, 2026
Merged

docs: simplify README and add schema-based USERGUIDE#133
mike-dubman merged 2 commits intoMellanox:masterfrom
mike-dubman:feature/readme-rework-ci-usage

Conversation

@mike-dubman
Copy link
Collaborator

Goal

Make project documentation shorter, clearer, and aligned with current CI behavior.

What changed

  • Reworked README.md into a compact, task-oriented guide:
    • explicit goal/role section
    • local and GHA flow overview
    • prerequisites and key commands
    • troubleshooting and logs
    • pipeline image reference restored (.ci/pict/snapshot2.png)
    • link to schema-driven user guide
  • Added USERGUIDE.md generated from current schema structure (schema_validator/ci_demo_schema.yaml):
    • top-level keys reference
    • section-level schemas
    • minimal and k8 examples
    • validation usage

Scope

Documentation-only PR (README.md, USERGUIDE.md).

mike-dubman and others added 2 commits February 20, 2026 08:15
- streamline README with clear local/GHA flow and goals\n- restore pipeline image reference\n- add USERGUIDE.md generated from ci-demo schema
@mike-dubman mike-dubman merged commit 3209ddd into Mellanox:master Feb 20, 2026
2 checks passed
@mike-dubman mike-dubman deleted the feature/readme-rework-ci-usage branch February 20, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant