Notes to Improve Clarity and Detail in Developer Setup Documentation#408
Draft
Notes to Improve Clarity and Detail in Developer Setup Documentation#408
Conversation
Clarified instructions and added recommendations for troubleshooting common errors in the documentation. NOTE: I also wasn't sure if this draft should be an actual new/improved setup documentation, or if I was supposed to make edits to the existing documentation, so I created these notes and put together all of my feedback here for now, just to be safe. ALSO wasn't sure if there was some other Developer Documentation that I should have been looking at (maybe the API Documentation?), so please let me know if that is the case and I'll take a look! Any feedback or instructions on how I should proceed from here would be much appreciated. Thanks!
|
✅ @coderNini — Superconductor finished — View implementation | App Preview Standing by for instructions. |
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
1 participant
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.
Any feedback or instructions on how I should proceed from here would be much appreciated. Thanks!
General Info
- Clarified instructions and added recommendations for troubleshooting common errors in the documentation. All of this can be found in the newly created file, Developer-Documentation-Draft.md.
- NOTE: I wasn't sure if this draft should be an actual new/improved setup documentation, or if I was supposed to make edits to the existing documentation, so I created these notes and put together all of my feedback here for now, just to be safe.
- ALSO wasn't sure if there was some other Developer Documentation that I should have been looking at (maybe the API Documentation?), so please let me know if that is the case and I'll take a look!
Changes
Testing
Explain how you tested your changes. If testing is not necessary, explain why.
Documentation
Does this PR require documentation. If so, explain where it can be found.
Checklist
- Again, any comments/notes on what my next steps should be would be super helpful, as well as clarification on the notes that I left above. Thank you!!