improved clarity in workshop documentation#1196
Closed
rthivisha wants to merge 2 commits intofreeCodeCamp:mainfrom
Closed
improved clarity in workshop documentation#1196rthivisha wants to merge 2 commits intofreeCodeCamp:mainfrom
rthivisha wants to merge 2 commits intofreeCodeCamp:mainfrom
Conversation
| ## Styling pointers | ||
|
|
||
| Workshops should alternate steps in which new concepts are introduced small piece by piece, and steps where there is freedom of implementation. | ||
| Workshops should introduce new concepts gradually. Break complex ideas into small, easy-to-understand steps. |
Contributor
There was a problem hiding this comment.
this changes the meaning of the sentence completely, have you moved somewhere else the part about "steps where there is freedom of implementation"?
Author
There was a problem hiding this comment.
Thank you for pointing that out. I did not move that part elsewhere — my intention was to improve clarity, but I see that it changes the meaning.I can revise the sentence to preserve the original idea about freedom of implementation.
| #### How to Run the Script | ||
|
|
||
| 1. Change to the directory of the project. | ||
| 1. Change the directory to the currrent project by copying the path and running in terminal. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Change the directory to the currrent project by copying the path and running in terminal. | |
| 1. Change to the directory of the currrent project. |
| ## Proposing a Pull Request (PR) | ||
|
|
||
| After you've committed your changes, check here for [how to open a Pull Request](/how-to-open-a-pull-request/). | ||
| After you've committed your changes, check here for [how to open a Pull Request](/how-to-open-a-pull-request/) and thats's a quick step . |
Contributor
There was a problem hiding this comment.
Suggested change
| After you've committed your changes, check here for [how to open a Pull Request](/how-to-open-a-pull-request/) and thats's a quick step . | |
| After you've committed your changes, check here for [how to open a Pull Request](/how-to-open-a-pull-request/). |
what does "and that's a quick step" mean?
Contributor
|
closing this PR. If there is something unclear please open an issue about this. It would be great if you had some experience with contributing with workshops first. |
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
2 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.
This PR improves grammar, formatting, and clarity in the workshop documentation.
No structural or functional changes were made.