HYPERFLEET-411: Add HyperFleet directory structure standard documentation #58
Conversation
WalkthroughThis pull request introduces a new documentation file, Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.18.1)standards/directory-structure.md56-56: Fenced code blocks should have a language specified (MD040, fenced-code-language) Comment |
![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
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
hyperfleet/docs/directory-structure.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/docs/directory-structure.md
56-56: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
hyperfleet/docs/directory-structure.md (1)
1-213: Excellent comprehensive documentation on directory structure.The document is well-organized, clearly written, and provides practical guidance for repository standardization. The problem statement, goals, and scope are clearly articulated, and the directory layout is comprehensive with both required and optional sections. The tables effectively summarize directory purposes and
.gitignorerequirements.
| ``` | ||
| repo-root/ | ||
| ├── bin/ # Compiled binaries (gitignored) | ||
| │ └── app-name # Compiled binary (e.g., pull-secret, dns-adapter) | ||
| ├── build/ # Temporary build artifacts (gitignored) | ||
| │ ├── cache/ # Build cache | ||
| │ └── tmp/ # Temporary files | ||
| ├── cmd/ # Main application(s) | ||
| │ └── app-name/ # Application-specific directory (e.g., pull-secret/) | ||
| │ ├── main.go # Main executable | ||
| │ └── jobs/ # Job implementations (if applicable) | ||
| │ └── job.go | ||
| ├── pkg/ # Application libraries and packages | ||
| │ ├── api/ # API client libraries | ||
| │ ├── config/ # Configuration structures | ||
| │ ├── handlers/ # HTTP handlers | ||
| │ ├── services/ # Business logic | ||
| │ ├── models/ # Data models | ||
| │ └── utils/ # Utility functions | ||
| ├── openapi/ # OpenAPI/Swagger specifications (if applicable) | ||
| │ ├── api.yaml # OpenAPI 3.0 specification | ||
| │ └── v1/ # Versioned API specs | ||
| │ └── swagger.json | ||
| ├── k8s/ # Kubernetes manifests | ||
| │ ├── base/ # Base Kustomize configuration | ||
| │ ├── overlays/ # Environment-specific overlays | ||
| │ │ ├── dev/ | ||
| │ │ ├── staging/ | ||
| │ │ └── prod/ | ||
| │ └── crds/ # Custom Resource Definitions (if applicable) | ||
| ├── helm/ # Helm charts (if applicable) | ||
| │ └── chart-name/ # Helm chart directory | ||
| │ ├── Chart.yaml | ||
| │ ├── values.yaml | ||
| │ └── templates/ | ||
| ├── docs/ # Documentation | ||
| │ ├── architecture.md | ||
| │ ├── api.md | ||
| │ └── development.md | ||
| ├── scripts/ # Helper scripts | ||
| │ ├── setup.sh | ||
| │ └── deploy.sh | ||
| ├── test/ # Integration and E2E tests | ||
| │ ├── integration/ | ||
| │ └── e2e/ | ||
| ├── .github/ # GitHub configuration | ||
| │ └── workflows/ # GitHub Actions | ||
| ├── Makefile # Standard Makefile (see makefile-conventions.md) | ||
| ├── Dockerfile # Container definition | ||
| ├── .gitignore # Git ignore rules | ||
| ├── go.mod # Go module definition (for Go projects) | ||
| ├── go.sum # Go module checksums | ||
| └── README.md # Project documentation | ||
| ``` |
There was a problem hiding this comment.
Add language specification to the directory tree code block.
The fenced code block is missing a language identifier. While the tree structure itself is clear, specifying the language improves rendering in tools and documentation systems.
🔎 Proposed fix
-```
+```text
repo-root/
├── bin/ # Compiled binaries (gitignored)🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
56-56: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In hyperfleet/docs/directory-structure.md around lines 56 to 109, the fenced
code block showing the repo tree lacks a language identifier; update the opening
fence from ``` to ```text (or another appropriate identifier like ```bash) so
the block becomes ```text repo-root/... and leave the closing ``` unchanged to
improve rendering.
|
@ldornele We need to update the path from /docs to /standards according to https://issues.redhat.com/browse/HYPERFLEET-424 |
|
Hey @rafabene, I updated the path from /docs to /standards accordingly. |
3 participants
This PR adds comprehensive documentation for the standard directory structure, related to HYPERFLEET-411.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.