From 2507000b00992fce07d7f0e7143ceac37d0a0cff Mon Sep 17 00:00:00 2001 From: gsgonzalez88 Date: Tue, 26 Sep 2023 00:13:26 -0300 Subject: [PATCH] docs: typos found in documentation page --- docs/src/content/docs/guides/checkout-answer.md | 6 +++--- docs/src/content/docs/guides/create-challenge.md | 6 +++--- docs/src/content/docs/guides/getting-started.md | 2 +- docs/src/content/docs/guides/resolve-challenge.md | 8 ++++---- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/src/content/docs/guides/checkout-answer.md b/docs/src/content/docs/guides/checkout-answer.md index 93856c8..f239849 100644 --- a/docs/src/content/docs/guides/checkout-answer.md +++ b/docs/src/content/docs/guides/checkout-answer.md @@ -1,13 +1,13 @@ --- -title: Checkout Somebody Answer -description: Guide to checkout the answer of someone else +title: Check out Somebody's Answer +description: Guide to checking out someone else's answer. sidebar: order: 3 --- All Angular Challenges answers will be presented in the form of a Pull Request (PR). To view and follow them, navigate through the **Files Changes** page on GitHub. However, understanding and following this process may not be straightforward if you are not familiar with the interface. In many cases, you may prefer to check out the branch and review the solution in your preferred IDE. -This guide has been created to help you in archieving this. +This guide has been created to help you in achieving this. ## Checkout a PR locally from someone else diff --git a/docs/src/content/docs/guides/create-challenge.md b/docs/src/content/docs/guides/create-challenge.md index 6861499..224758b 100644 --- a/docs/src/content/docs/guides/create-challenge.md +++ b/docs/src/content/docs/guides/create-challenge.md @@ -5,7 +5,7 @@ sidebar: order: 5 --- -You have an idea you want to share, an interesting bug you are struggling with in one or your private or side project, or an Angular trick you discovered. All of these possibilities are a good starting point to create a challenge and share the solution with others. +You have an idea you want to share, an interesting bug you are struggling with in one of your private or side project, or an Angular trick you discovered. All of these possibilities are a good starting point to create a challenge and share the solution with others. But how do you start creating these challenges? @@ -22,14 +22,14 @@ To streamline the process, I have created an Nx generator that will set up all t The title must be a maximum of 25 characters. ::: -- challengeDifficulty: The difficulty you think your challenge has. There are three difficulty level : 🟢 easy / 🟠 medium / 🔴 hard +- challengeDifficulty: The difficulty you think your challenge has. There are three difficulty levels : 🟢 easy / 🟠 medium / 🔴 hard - name: name of the Nx application. :::note It must be written in **Kebab-Case** ::: - docRepository: The category of your Challenge: Nx, Angular, Angular Performance, Rxjs, NgRx, Typescript. -#### optinal parameters +#### optional parameters - directory: If you want your application to be located in a specific folder inside `apps`. - addTest: If you want to add test configuration. diff --git a/docs/src/content/docs/guides/getting-started.md b/docs/src/content/docs/guides/getting-started.md index 01c0285..b3111c8 100644 --- a/docs/src/content/docs/guides/getting-started.md +++ b/docs/src/content/docs/guides/getting-started.md @@ -11,7 +11,7 @@ To get started with Angular Challenges, follow these steps: If you wish to submit an answer, you will need to have your own GitHub account. Additionally, having a GitHub account is always beneficial, and it's free. -## Folk the github project +## Fork the github project Navigate to the [Angular Challenges Repository](https://github.com/tomalaforge/angular-challenges) and click on the Fork button in the header. This will create a copy of this repository on your own GitHub page. diff --git a/docs/src/content/docs/guides/resolve-challenge.md b/docs/src/content/docs/guides/resolve-challenge.md index fa33a64..9570a7b 100644 --- a/docs/src/content/docs/guides/resolve-challenge.md +++ b/docs/src/content/docs/guides/resolve-challenge.md @@ -9,7 +9,7 @@ In this guide, you will learn how to resolve a challenge and submit an answer to ## Introduction -This repository is powered by [Nx](https://nx.dev/getting-started/intro). Nx is a monorepository that allows you to store multiple applications inside the same workspace. Each challenge is a separate application. If you open the `apps` directory, you will found multiple directories, each related to a specific challenge. Each directory represents a complete standalone `Nx` application. To run and start with one, open your terminal and run: +This repository is powered by [Nx](https://nx.dev/getting-started/intro). Nx is a monorepository that allows you to store multiple applications inside the same workspace. Each challenge is a separate application. If you open the `apps` directory, you will find multiple directories, each related to a specific challenge. Each directory represents a complete standalone `Nx` application. To run and start with one, open your terminal and run: ```bash npx nx serve @@ -46,7 +46,7 @@ Follow the instructions to resolve the challenge. The last step is to commit your work following the [Conventional Guidelines](https://www.conventionalcommits.org/en/v1.0.0/). -Finally, push your work to the remote reposository with the following command +Finally, push your work to the remote repository with the following command ```bash git push --set-upstream origin @@ -58,9 +58,9 @@ You don't have to remember the command precisely. You just need to remember `git ## Submit your Work to the Main Repository -Now, all your work is located insite your local instance of the Angular Challenge repository. +Now, all your work is located insite your local instance of the Angular Challenges repository. -The next step is to go to the main [Angular Challenge page](https://github.com/tomalaforge/angular-challenges) and create a new Pull Request. +The next step is to go to the main [Angular Challenges page](https://github.com/tomalaforge/angular-challenges) and create a new Pull Request. Github should display a notification header to help you create the pull request.