Skip to content

chore: add project structure diagram #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nanotaboada merged 1 commit into from
Apr 17, 2025
Merged

chore: add project structure diagram #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,18 @@

## Manifesto

> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — Linus Torvalds
> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — [Linus Torvalds](https://web.archive.org/web/20050404020308/http://www.linuxtimes.net/modules.php?name=News&file=article&sid=145)
## About

Proof of Concept for a Web API made with [.NET 8](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8) (LTS) and [ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-8.0?view=aspnetcore-8.0).

## Structure

![Structure](/assets/images/Structure.svg)

_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._

Comment on lines +21 to +26
Copy link

@coderabbitai coderabbitai bot Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Enhance accessibility and verify the diagram asset
The new “Structure” section adds valuable context, but the image’s alt text is very generic (“Structure”). For screen-reader users, consider a more descriptive label (e.g., “Project conceptual structure and application flow diagram”). Also, please confirm that assets/images/Structure.svg is present in the repository and up‑to‑date by running the following check:

🏁 Script executed:

#!/bin/bash
# Verify that the Structure diagram exists
if [ ! -f assets/images/Structure.svg ]; then
  echo "ERROR: assets/images/Structure.svg not found"
  exit 1
else
  echo "✅ assets/images/Structure.svg found"
fi

Length of output: 125

Update alt text for better accessibility
The diagram asset exists at assets/images/Structure.svg (✅ verified), but the current alt text (“Structure”) is too generic. Please update it to a more descriptive label to aid screen‑reader users.

• File: README.md (Structure section)
• Replace the image line with something like:

- ![Structure](/assets/images/Structure.svg)
+ ![Project conceptual structure and application flow diagram](/assets/images/Structure.svg)
📝 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.

Suggested change
## Structure
![Structure](/assets/images/Structure.svg)
_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._
## Structure
![Project conceptual structure and application flow diagram](/assets/images/Structure.svg)
_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._

## Start

```console
Expand Down
Loading
Loading