docs: improve getting started guidance - #19851
Open
vedprakashrana wants to merge 1 commit into
Open
Conversation
vedprakashrana
requested review from
fdcavalcanti,
hartmannathan and
xiaoxiang781216
as code owners
August 14, 2026 15:04
xiaoxiang781216
approved these changes
Aug 15, 2026
github-actions
Bot
added
Area: Documentation
|
vedprakashrana
force-pushed
the
docs-first-contribution
branch
from
August 15, 2026 09:48
525f31b to
284ec86
Compare
Add a note for first-time contributors explaining that building the simulator locally can help verify the development environment before submitting changes. Assisted-by: ChatGPT:GPT-5.6 Luna Signed-off-by: Vedprakash Rana <vedprakashkumarrana8@gmail.com>
vedprakashrana
force-pushed
the
docs-first-contribution
branch
from
August 15, 2026 13:08
284ec86 to
0836d13
Compare
xiaoxiang781216
approved these changes
Aug 15, 2026
Contributor
|
I don't think this info belongs on getting started of the README, but on contribution page. If you want to improve the docs, improve the docs. |
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
3 participants
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.
Summary
Improve the Getting Started section by adding a short note for first-time contributors.
Impact
Documentation only. No functional or build changes.
Testing
sim:nsh.make -j$(nproc)../nuttx.helpuname -ahello(output:Hello, World!!)