Skip to content

Conversation

@jcabad100
Copy link
Contributor

@jcabad100 jcabad100 commented Dec 27, 2021

Description

  • Documentation improvements according current state of matter e.g. Console is the debugger System console and not the the device one nanoFramework.Console.
  • Additional notes added for the newbies to have an easier start.
  • Changes on all screen initialization and Console related code tested on a StickCPlus....screen initialization for Core2 and StickC must be added yet

Motivation and Context

  • Documentation was not in-synch with implementation
  • Documentation made it difficult for the newbies to know where to start
  • M5Stack wrongly used to refer to Core (gray), M5Stack is the name of the company.

How Has This Been Tested?

  • Changes on all screen initialization and Console related code tested on a StickCPlus (Visual Studio 2022 Commnity on WIndows 10).

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (work on Unit Tests, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Documentation improvements according current state of matter e.g. Console is the debugger System console and not the the device one nanoFramework.Console. Additional notes added for the newbies to have an easier start. Changes on all screen initialization and  Console related code tested on a StickCPlus....screen initialization for Core2 and StickC must be added yet.
@nfbot nfbot changed the title Update README.md to improve documentation and synch it with current implementation. Update README.md to improve documentation and synch it with current implementation Dec 27, 2021
@nfbot
Copy link
Member

nfbot commented Dec 27, 2021

@jcabad100 I've fixed the checklist for you.
FYI, the correct format is [x], no spaces inside brackets.

@josesimoes josesimoes added the Type: documentation Improvements or additions to documentation label Dec 27, 2021
Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

Nice improvements! Thanks.
Just added some comments/suggestions to improve clarity.

@josesimoes josesimoes requested a review from Ellerbach December 27, 2021 13:18
jcabad100 and others added 12 commits December 27, 2021 22:47
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Co-authored-by: José Simões <jose.simoes@eclo.solutions>
Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

I ended up committing the change suggestion myself. Approved!

@josesimoes josesimoes enabled auto-merge (squash) December 28, 2021 10:32
@josesimoes josesimoes changed the title Update README.md to improve documentation and synch it with current implementation Update README.md Dec 28, 2021
@josesimoes josesimoes removed the request for review from Ellerbach December 28, 2021 10:32
@josesimoes josesimoes disabled auto-merge December 28, 2021 11:02
@josesimoes josesimoes merged commit b353052 into nanoframework:develop Dec 28, 2021
@nfbot
Copy link
Member

nfbot commented Dec 28, 2021

@jcabad100 thank you again for your contribution! 🙏😄

.NET nanoFramework it's all about community involvement and no contribution is too small.
We would like to invite you to join the project Contributors list.

Please edit it and add an entry with your GitHub user in the appropriate location (names sorted alphabetically):

  <tr>
    <td><img src="https://github.com/jcabad100.png?size=50&" height="50" width="50" ></td>
    <td><a href="https://github.com/jcabad100">Juan Carlos Abad</a></td>
  </tr>

(feel free to adjust your name, if it's not correct)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants