Update Documentation

[gtref]

Description

This task is relatively simple. It requires you to look at the current documentation and fix any spelling mistakes or words/sentences that do not make sense.

Tasks

• You will be looking at documentation, as well as interpreting the JavaScript/HTML if necessary.
• You will replace words/sentences that don't make sense or need updating due to feature changes.
• You will need to submit your changes in a pull request that documents what you changed.

Steps

1. You will need to fork the repository to your GitHub account. To do this, press the Fork button on the repository's code page.
2. Clone your fork to your local machine. Make sure you have Git installed first; if not, please install it.
3. Once Git is installed, run the following command to clone the repository:

git clone https://github.com/your-username/satiscode.git

(Replace your-username with your actual GitHub username.)

4. Navigate into the repository directory and create a new branch for your work:

cd satiscode
git branch your-branch-name
git switch your-branch-name

(Replace your-branch-name with a descriptive name for your branch.)

5. Make your documentation changes in your editor.
6. Stage, commit, and push your changes to your fork:

git add .
git commit -s -m "Your commit message"
git push -u origin your-branch-name

Note: If you get an error asking to configure user.name and user.email, run the following commands with your details before committing:

git config --global user.name "your-github-username"
git config --global user.email "you@your-email.com"

7. Go to the main repository at https://github.com/gtref/satiscode and submit a pull request from your fork.

After you complete this please in the same PR update the file CONTRIBUTORS.md with your details if you would like to be acknowledged

[sharmiramesh78-ship-it]

I would like to work on this documentation update.

[gtref]

Thank you for contributing. If you need any help or you get stuck please draft a pull request or issue outlining the issue.

[gtref]

Do you still want this issue?

[sharmiramesh78-ship-it]

Yes, I still want to work on this issue. I’ll start working on it. Thank you!

[gtref]

Thank you. I was only asking because there was no response since I added you to this issue.

[sharmiramesh78-ship-it]

Yes, I still want to work on this issue. Thank you!