Add README for generics public preview #3157
Conversation
- Add links to both main README files. - Expand targets tables to include preview versions. - Minor formating fixes.
WalkthroughThis update introduces documentation and README changes to announce and explain the public preview of generics support in the .NET nanoFramework CLR. A new dedicated document, Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Firmware
participant Tooling
User->>Documentation: Reads about generics support and preview instructions
User->>Tooling: Updates Visual Studio extension and NuGet packages as instructed
User->>Firmware: Installs preview firmware with generics support
User->>Documentation: Refers to known issues and feedback channels
Possibly related PRs
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
README.md (2)
18-22: Minor punctuation improvement in new preview section
Add a comma for clarity in the sentence on line 21.
Suggested change:- If you want to use this feature please refer to the documentation [here](README-GENERICS.md). + If you want to use this feature, please refer to the documentation [here](README-GENERICS.md).🧰 Tools
🪛 LanguageTool
[typographical] ~21-~21: It seems that a comma is missing.
Context: ...enerics. If you want to use this feature please refer to the documentation [here](READM...(IF_PLEASE_COMMA)
40-40: Remove stray semicolon in separator line
The line-----;appears to include an unintended semicolon and may disrupt Markdown rendering. It should be:- -----; + -----README.zh-cn.md (1)
18-21: Remove trailing spaces after Chinese sentence
Line 20 ends with two spaces; remove the extra whitespace to clean up formatting.README-GENERICS.md (2)
42-43: Clarify comparative phrasing
The clause “similarly to how they would on the full .NET runtime” lacks an explicit verb and may read awkwardly.
Suggested revision:- …write more flexible and reusable code on microcontrollers, similarly to how they would on the full .NET runtime. + …write more flexible and reusable code on microcontrollers, similar to how they can on the full .NET runtime.🧰 Tools
🪛 LanguageTool
[grammar] ~42-~42: It seems that a verb is missing.
Context: ...microcontrollers, similarly to how they would on the full .NET runtime. Keep in mind ...(MD_DT_JJ)
75-75: Add hyphens for compound adjectives
Use hyphens in “pre- and post-generics projects” for correct compound adjective styling.
Suggested revision:- …not possible to support pre and post generics projects… + …not possible to support pre‑ and post‑generics projects…🧰 Tools
🪛 LanguageTool
[grammar] ~75-~75: It appears that hyphens are missing.
Context: ...extension, it's not possible to support pre and post generics projects with the same extension. There...(PRE_AND_POST_NN)
[grammar] ~75-~75: It appears that hyphens are missing.
Context: ...ersions. It is not an option to install pre and post generics extensions in VS2019 and VS2022, for ex...(PRE_AND_POST_NN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README-GENERICS.md(1 hunks)README.md(4 hunks)README.zh-cn.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.zh-cn.md
[style] ~119-~119: Using many exclamation marks might seem excessive (in this case: 90 exclamation marks for a text that’s 39429 characters long)
Context: ...-|---|---| | TI_CC1352R1_LAUNCHXL_868 | |
| | TI_CC1352R1_LAUNCHXL_915 |
|
| | TI_CC3220SF_LAUNCHXL | [
README.md
[typographical] ~21-~21: It seems that a comma is missing.
Context: ...enerics. If you want to use this feature please refer to the documentation [here](READM...
(IF_PLEASE_COMMA)
[style] ~131-~131: Using many exclamation marks might seem excessive (in this case: 91 exclamation marks for a text that’s 43399 characters long)
Context: ...-|---|---| | TI_CC1352R1_LAUNCHXL_868 | |
| | TI_CC1352R1_LAUNCHXL_915 |
|
| | TI_CC3220SF_LAUNCHXL | [
README-GENERICS.md
[grammar] ~42-~42: It seems that a verb is missing.
Context: ...microcontrollers, similarly to how they would on the full .NET runtime. Keep in mind ...
(MD_DT_JJ)
[grammar] ~75-~75: It appears that hyphens are missing.
Context: ...extension, it's not possible to support pre and post generics projects with the same extension. There...
(PRE_AND_POST_NN)
[grammar] ~75-~75: It appears that hyphens are missing.
Context: ...ersions. It is not an option to install pre and post generics extensions in VS2019 and VS2022, for ex...
(PRE_AND_POST_NN)
🔇 Additional comments (11)
README.md (1)
44-45: Preview column added correctly
The new “Preview” column header and its alignment row are clear and consistent with existing table formatting.README.zh-cn.md (1)
32-33: 新增“预览”列标题格式正确
表头新增的“预览”列及其对齐符号符合 Markdown 规范，清晰易读。README-GENERICS.md (9)
1-4: Great new documentation file
The title and overview section clearly introduce the purpose and context of the generics public preview.
5-12: Clear explanation of generics benefits
The bullet points for type safety, reusability, and performance are well‑written and concise.
13-25: Well‑formed generic method example
The sample code forMax<T>demonstrates usage effectively and follows standard C# conventions.
27-38: Effective generic class illustration
TheStack<T>class example is simple, accurate, and easy to follow.
44-58: Firmware flashing instructions are clear
Thenanoff --previewexample and notes accurately guide users through applying preview firmware.
61-70: VSIX installation steps are well detailed
The instructions for downloading and installing the preview Visual Studio extension are precise and user‑friendly.
77-86: NuGet package update guidance is solid
The steps for enabling prerelease packages and aligning versions are clear and actionable.
88-98: Feedback and known issues section is comprehensive
The caveats around debugging quirks and memory usage set proper expectations for users.
99-100: Strong closing call to action
The thank‑you note and invitation for feedback provide a positive wrap‑up.
Description
Motivation and Context
How Has This Been Tested?
Screenshots
Types of changes
Checklist
Summary by CodeRabbit