docs(readme): add What's New sections for v5.0 and v6.0 - #474
Merged
Conversation
README only documented the v4.0 architectural rewrite as a milestone, leaving readers with no summary of the ~4.5 months of work that followed (ROI overhaul, closed-loop stimulation, i18n) or of the v6.0.0 archival snapshot itself. Adds two new sections, mirrored in README.pt-BR.md, built from git log/diff between the v4.0.0, v5.0.0-rc1 and v6.0.0 tags rather than from memory.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds “What’s New” sections for v5.0 and v6.0 to the English and pt-BR READMEs, updating the project’s high-level changelog narrative beyond the v4.0 architecture milestone.
Changes:
- Added a new “What’s New in Version 6.0” section near the top of both READMEs.
- Added a new “Milestone: Version 5.0” section summarizing the major post-v4.0 work.
- Tweaked the v4.0 transition sentence to avoid redundancy with the new sections.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds v6.0 “What’s New” + v5.0 milestone sections and adjusts the v4.0 transition text. |
| README.pt-BR.md | Mirrors the same v6.0/v5.0 sections and updates the v4.0 transition sentence in Portuguese. |
Suppressed comments (1)
README.md:139
- Spelling is inconsistent within README.md: later sections use "catalog" (e.g., "weight catalog"), but this new bullet uses "catalogue". Consider standardizing on one variant (likely "catalog" throughout the English README).
- **🌐 English as the Interface Source Language**: full Portuguese (pt-BR) locale catalogue;
translations resolved at call time, never at import time; an unaccented-Portuguese scanner in
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+87
to
+90
| - **📦 Archival Readiness**: `.zenodo.json` with complete metadata (authors, ORCID, licence, | ||
| INPI registration, funding); `CITATION.cff` updated to `6.0.0`; internal grant-agency material | ||
| (unpublished manuscripts, partial reports, proposals, a finance spreadsheet) curated out of the | ||
| publicly archived tree. |
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
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.
Resumo
O README só documentava a reescrita arquitetural v4.0 como marco, sem nenhum resumo dos ~4,5 meses de trabalho desde então (revisão de ROI, estimulação closed-loop, i18n) nem do próprio snapshot de arquivamento v6.0.0.
## 🚀 What's New in Version 6.0(novo, no topo) e## 🏗️ Milestone: Version 5.0, espelhados emREADME.pt-BR.md.git log/git diffentre as tagsv4.0.0,v5.0.0-rc1ev6.0.0(não de memória) — v5.0 cobre tudo entrev4.0.0ev5.0.0-rc1; v6.0 cobre exatamente o que mudou entrev5.0.0-rc1e a tagv6.0.0atual.Test plan
pre-commit(markdownlint, etc.) — limpomypy .(hook de pre-push) — limpo🤖 Generated with Claude Code