Skip to content

Conversation

@rafabene
Copy link
Contributor

@rafabene rafabene commented Dec 30, 2025

Summary

Moves all standards documents from /docs to /standards directory as specified in epic HYPERFLEET-374.

Documents Moved

Document Related Ticket
error-model.md HYPERFLEET-378
makefile-conventions.md HYPERFLEET-377
health-endpoints.md HYPERFLEET-381
generated-code-policy.md HYPERFLEET-303
graceful-shutdown.md HYPERFLEET-384
logging-specification.md HYPERFLEET-323

Links Updated

Updated all internal references in component documentation:

  • api-versioning.md
  • sentinel.md
  • sentinel-deployment.md
  • adapter-deployment.md
  • adapter-design-decisions.md
  • adapter-frame-design.md
  • adapter-metrics.md

Test Plan

  • Verify no broken links (grep for old paths returns no matches)
  • Review all updated references point to correct files

Closes HYPERFLEET-424

Summary by CodeRabbit

  • Documentation
    • Updated documentation cross-references across multiple components to point to standardized specifications. Links now direct to the standards directory for consistency, covering logging specifications, health endpoints, error models, and graceful shutdown guidelines.

✏️ Tip: You can customize this high-level summary in your review settings.

Move the following standards documents to dedicated /standards directory:
- error-model.md (HYPERFLEET-378)
- makefile-conventions.md (HYPERFLEET-377)
- health-endpoints.md (HYPERFLEET-381)
- generated-code-policy.md (HYPERFLEET-303)
- graceful-shutdown.md (HYPERFLEET-384)
- logging-specification.md (HYPERFLEET-323)

Update all internal links in component documentation to reference
the new /standards path.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 30, 2025

Walkthrough

This PR updates documentation cross-reference links across seven markdown files in the adapter framework, API service, and sentinel components. The changes redirect links from /docs/ to /standards/ directories for specifications including logging-specification, health-endpoints, graceful-shutdown, and error-model. No code changes or functional modifications are included.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • xueli181114
  • rh-amarin

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation references from /docs to /standards directory as part of the HYPERFLEET-424 ticket.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb4ff0f and 8c67d34.

📒 Files selected for processing (13)
  • hyperfleet/components/adapter/framework/adapter-deployment.md
  • hyperfleet/components/adapter/framework/adapter-design-decisions.md
  • hyperfleet/components/adapter/framework/adapter-frame-design.md
  • hyperfleet/components/adapter/framework/adapter-metrics.md
  • hyperfleet/components/api-service/api-versioning.md
  • hyperfleet/components/sentinel/sentinel-deployment.md
  • hyperfleet/components/sentinel/sentinel.md
  • hyperfleet/standards/error-model.md
  • hyperfleet/standards/generated-code-policy.md
  • hyperfleet/standards/graceful-shutdown.md
  • hyperfleet/standards/health-endpoints.md
  • hyperfleet/standards/logging-specification.md
  • hyperfleet/standards/makefile-conventions.md
🔇 Additional comments (10)
hyperfleet/components/adapter/framework/adapter-design-decisions.md (1)

458-458: Link path update verified.

The cross-reference to the Logging Specification has been correctly updated from the docs path to the standards path.

hyperfleet/components/adapter/framework/adapter-metrics.md (1)

53-53: Link path update verified.

The cross-reference to the Health Endpoints Specification has been correctly updated to the standards path with proper relative path navigation.

hyperfleet/components/sentinel/sentinel.md (2)

758-758: Link path update verified.

The cross-reference to the Graceful Shutdown standard has been correctly updated with proper relative path navigation from the sentinel component location.


916-916: Link path update verified.

The cross-reference to the Logging Specification has been correctly updated to the standards path.

hyperfleet/components/adapter/framework/adapter-frame-design.md (1)

763-763: Link path update verified.

The cross-reference to the Graceful Shutdown Standard has been correctly updated to the standards path with proper relative path navigation.

hyperfleet/components/sentinel/sentinel-deployment.md (1)

219-219: Link path update verified.

The cross-reference to the Health Endpoints Specification has been correctly updated with proper relative path navigation from the sentinel deployment documentation.

hyperfleet/components/adapter/framework/adapter-deployment.md (2)

9-9: Link path update verified.

The cross-reference to the Logging Specification has been correctly updated to the standards path in the deployment guide.


503-503: Link path update verified.

The cross-reference to the Health Endpoints Specification has been correctly updated to the standards path.

hyperfleet/components/api-service/api-versioning.md (2)

87-87: Link path update verified.

The cross-reference to the Error Model standard has been correctly updated in the main content section with proper relative path navigation from the API service location.


184-184: Link path update verified.

The cross-reference to the Error Model standard in the References section has been correctly updated to the standards path, maintaining consistency with the link in the main content.


Comment @coderabbitai help to get the list of available commands and usage tips.

@xueli181114 xueli181114 merged commit 1dd9730 into openshift-hyperfleet:main Dec 31, 2025
1 check passed
@coderabbitai coderabbitai bot mentioned this pull request Jan 15, 2026
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.

2 participants