I have built this project using HTML and CSS, as a part of my Responsive Web Design certification in FreeCodeCamp curriculum. Technical Documentation Page is a responsive webpage that consists of JavaScript documentation with a navigation menu on the left, for seamless navigation throughout the webpage.
Here's a Preview of Technical Documentation Page
Click here to see the Live Preview of this page.
If you want to contribute to this project, follow the below steps.
-
Fork the Repository : Click on the "Fork" button at the top right corner of this page. This creates a copy of the project under your own GitHub account.
-
Clone the Repository : Once you've forked the repository, open a terminal or command prompt, navigate to your desired directory, and run the following command.
git clone https://github.com/username/Technical-Documentation-Page.git
Here, replace "username" with your GitHub username.
-
Create a Branch : It's good practice to create a new branch for your contributions. This keeps your changes isolated from the main project.
Run the following command to create and switch to a new branch.
git switch -c your-branch-name
Replace "your-branch-name" with a descriptive name for your branch.
-
Make Changes : Open the project in your preferred text editor or IDE and make the necessary changes or additions to the project files.
-
Commit Changes : After making your changes, save the files and go back to the terminal or command prompt.
Use the following command to stage your changes for commit.
git add file-name
This command adds all modified and new files for commit. Here, replace "file-name" with the file names.
Next, commit your changes with a descriptive commit message.
git commit -m "Your commit message"
-
Push Changes : Push your local branch with the committed changes to your forked repository on GitHub using the following command.
git push -u origin your-branch-name
Replace "your-branch-name" with the name of the branch you created earlier.
-
Create a Pull Request : Once your changes are pushed to your forked repository on GitHub, You should see a message suggesting you create a pull request.
Click on the "Compare & pull request" button and provide a clear title and description for your pull request, explaining the changes you've made and submit it.
Congratulations! You have successfully contributed to the project.
This project is MIT Licensed.