Skip to content

Review readme#7

Merged
ifoche merged 3 commits intomasterfrom
feature/improve_readme
Apr 21, 2026
Merged

Review readme#7
ifoche merged 3 commits intomasterfrom
feature/improve_readme

Conversation

@idelcano
Copy link
Copy Markdown
Contributor

Improve readme

@idelcano idelcano requested review from Copilot and ifoche April 21, 2026 13:16
@idelcano idelcano marked this pull request as ready for review April 21, 2026 13:16
@bundlemon
Copy link
Copy Markdown

bundlemon Bot commented Apr 21, 2026

BundleMon

No change in files bundle size

Unchanged groups (1)
Status Path Size Limits
Build Folder
./**/*
995.89KB +20%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the project README to provide clearer setup instructions and a more complete description of the app’s capabilities.

Changes:

  • Rewrites the quick start/setup sections into clearer Installation/Development/Build instructions.
  • Adds a detailed Features section describing the two main tabs and graph visualization modes.
  • Documents high-level architecture (Clean Architecture + CompositionRoot) and i18n workflows.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 21, 2026 13:22
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Member

@ifoche ifoche left a comment

Choose a reason for hiding this comment

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

thanks @idelcano

@ifoche ifoche merged commit d002882 into master Apr 21, 2026
4 of 5 checks passed
@ifoche ifoche deleted the feature/improve_readme branch April 21, 2026 13:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

- You can use `.env` variables within the React app: `const value = import.meta.env.NAME;`
```
$ yarn extract-pot
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

The i18n instructions run yarn extract-pot and then yarn localize, but localize already runs update-po, which itself calls extract-pot (see package.json scripts). This makes the documented steps redundant and can slow down workflows; consider documenting just yarn localize, or adjusting the scripts so each step is necessary.

Suggested change
$ yarn extract-pot

Copilot uses AI. Check for mistakes.
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.

3 participants