Documentation Updates #133
Conversation
|
Still a draft. Would like to gather first feedback on the approach before polishing things. |
|
Sigh....CI failing. I believe there were some updates regarding Github runners rolled out. In any case, not yet updated dependencies complain. Will look into those tomorrow. |
|
CI fix in #134 |
There was a problem hiding this comment.
Updates the README to add some documentation for end users.
This PR focuses on prerequisites and launch configuration settings.
These sections look good
It probably doesn't make sense to extensively document the Memory Browser window which to my understanding is planned to be removed in future when some integration issues with Memory Inspector in the cdt-gdb-adapter are solved.
+1 I think the memory browser can be mentioned, but should direct to memory inspector + #110 for people to comment if they have any real use for the one in this extension, but not much more.
I also think everything from https://github.com/jreineckearm/cdt-gdb-vscode/tree/launch-settings-docs?tab=readme-ov-file#building on should be moved out of readme and into a new building.md or similar.
README.md
Outdated
| ## Launch Settings | ||
|
|
||
| TODO | ||
| ## Prequisites |
There was a problem hiding this comment.
Spelling. I'm not checking for spelling really, I recommend installing https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker or something similar in vscode to handle spell checking. It wouldn't surprise me if there are misspellings in the launch.json that have been copied into here (like examinging below :-)
| ## Prequisites | |
| ## Prerequisites |
There was a problem hiding this comment.
Ooops ... thanks! Will run a spell checker on it before it becomes a full PR. And update findings in package.json accordingly.
81756d7 to
5b36f5d
Compare
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Co-authored-by: Jonah Graham <jonah@kichwacoders.com> Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
5b36f5d to
5d6ad55
Compare
|
Ready now for review after last rebase |
There was a problem hiding this comment.
LGTM
I leave it up to @thegecko to do a review too as I am happy with what is present, but I would appreciate it if someone with experience of publishing to marketplace makes sure everything is here.
Updates the README to add some documentation for end users.
This PR focuses on prerequisites and launch configuration settings.
It probably doesn't make sense to extensively document the Memory Browser window which to my understanding is planned to be removed in future when some integration issues with Memory Inspector in the cdt-gdb-adapter are solved.