chore : update readme to capture more details of the repo - #5
Merged
ciaranRoche merged 1 commit intoOct 24, 2025
Merged
Conversation
rh-amarin
reviewed
Oct 22, 2025
| # HyperFleet Architecture Repository | ||
|
|
||
| This repository serves as the central hub for all architectural documentation related to Hyperfleet. | ||
| **Status**: Active |
Collaborator
There was a problem hiding this comment.
Double spaces at the end of the line will render these as individual lines for clarity
Also backslash if you want it to be more obvious
rh-amarin
reviewed
Oct 22, 2025
| ## Repository Structure | ||
|
|
||
| ``` | ||
| architecture/ |
Collaborator
There was a problem hiding this comment.
Do we need a folder for ADRs ? or ar the documents supposed to be the ADRs themselves?
Contributor
Author
There was a problem hiding this comment.
I was thinking we not impose an ADR process just yet, we bake into our definition of done, when code is merged there is a corresponding update to the architecture here, once we get passed MVP/POC phase we can implement an ADR process
rh-amarin
reviewed
Oct 22, 2025
rh-amarin
reviewed
Oct 22, 2025
rh-amarin
reviewed
Oct 22, 2025
ciaranRoche
force-pushed
the
readme-trade-off
branch
from
October 24, 2025 12:07
7b1c84d to
f677479
Compare
rh-amarin
approved these changes
Oct 24, 2025
This was referenced Jun 25, 2026
Closed
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This updates the README to capture the what and structure of this repo. It also importantly captures these are living documents and we need to capture trade-offs in the architecture and components we make