HYPERFLEET-761 - docs: align with documentation standards#30
HYPERFLEET-761 - docs: align with documentation standards#30rh-amarin wants to merge 2 commits intoopenshift-hyperfleet:mainfrom
Conversation
Add CONTRIBUTING.md, CHANGELOG.md, and CLAUDE.md to meet HyperFleet documentation standards and optimize for AI agent workflows. - CONTRIBUTING.md: Development setup, repo structure, testing, commit standards, and release process - CHANGELOG.md: Keep a Changelog format with semantic versioning - CLAUDE.md: AI agent context under 200 lines with build commands, validation checklist, code conventions, and boundaries - README.md: Add Architecture repo link and Contributing section Addresses requirements from HYPERFLEET-761 for standardizing documentation across HyperFleet repositories. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add v1.0.0 and v1.0.2 release entries with key changes extracted from GitHub release notes. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
WalkthroughDocumentation files have been added to the HyperFleet API specification repository. A new Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
rh-amarin
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.md`:
- Line 28: Change the release note sentence on Line 28 from “Updated OWNERS file
to not block approval by bot” to a clearer phrasing such as “Updated OWNERS file
to prevent bot approval from being blocked.” Locate the text in CHANGELOG.md and
replace the awkward construction with the suggested wording (or equivalent clear
passive-voice-free phrasing) so the intent reads smoothly.
In `@CLAUDE.md`:
- Line 40: Two fenced code blocks in CLAUDE.md (one containing the text
"Provider-specific → `models-{provider}/`" and the other the similar
provider-path example) are missing language info strings; update each
triple-backtick fence to include a language identifier such as "text" or "bash"
(e.g., change ``` to ```text) so the markdown lint rule MD040 is satisfied and
the examples render/lint correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8b62fd26-cca1-46bd-8f73-491a1963cad4
📒 Files selected for processing (4)
CHANGELOG.mdCLAUDE.mdCONTRIBUTING.mdREADME.md
| ### Changed | ||
| - Standardized TypeSpec schema definitions with enums and validation enhancements | ||
| - Refactored to support oapi-codegen compatibility | ||
| - Updated OWNERS file to not block approval by bot |
There was a problem hiding this comment.
Improve wording clarity on Line 28.
“Updated OWNERS file to not block approval by bot” reads awkwardly in release notes. Prefer a clearer phrasing like “Updated OWNERS file to prevent bot approval from being blocked.”
Suggested edit
-- Updated OWNERS file to not block approval by bot
+- Updated OWNERS file to prevent bot approval from being blocked📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Updated OWNERS file to not block approval by bot | |
| - Updated OWNERS file to prevent bot approval from being blocked |
🧰 Tools
🪛 LanguageTool
[style] ~28-~28: Consider changing the order of words to improve your wording.
Context: ...gen compatibility - Updated OWNERS file to not block approval by bot ### Fixed - Rele...
(TO_NOT_VB)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CHANGELOG.md` at line 28, Change the release note sentence on Line 28 from
“Updated OWNERS file to not block approval by bot” to a clearer phrasing such as
“Updated OWNERS file to prevent bot approval from being blocked.” Locate the
text in CHANGELOG.md and replace the awkward construction with the suggested
wording (or equivalent clear passive-voice-free phrasing) so the intent reads
smoothly.
|
|
||
| **When adding new models:** | ||
| - Shared models → `models/` | ||
| - Provider-specific → `models-{provider}/` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks (MD040).
Markdown lint flags fenced blocks without a language at these lines. Add explicit info strings (for example, text or bash) to keep docs lint-clean.
Suggested fix pattern
-```
+```text
...
(Apply similarly to the other affected fenced block.)
</details>
Also applies to: 199-199
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.0)</summary>
[warning] 40-40: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @CLAUDE.md at line 40, Two fenced code blocks in CLAUDE.md (one containing
the text "Provider-specific → models-{provider}/" and the other the similar
provider-path example) are missing language info strings; update each
triple-backtick fence to include a language identifier such as "text" or "bash"
(e.g., change totext) so the markdown lint rule MD040 is satisfied and
the examples render/lint correctly.
</details>
<!-- fingerprinting:phantom:triton:hawk:a8eb15fd-9578-47e7-89aa-3de217432631 -->
<!-- This is an auto-generated comment by CodeRabbit -->
1 participant
https://redhat.atlassian.net/browse/HYPERFLEET-761
Added required files from our standard for documentation
Summary by CodeRabbit