-
Notifications
You must be signed in to change notification settings - Fork 146
Add documentation setup guide for the project #625
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nouri-devv
wants to merge
2
commits into
thoth-tech:main
Choose a base branch
from
nouri-devv:mostafa/Documentation-Project-Set-Up-and-Process
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
80 changes: 80 additions & 0 deletions
80
...s/projects/docusaurus-documentation/Documentation_Project_Set_Up_and_Process.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| title: Documentation Project Set Up and Process | ||
| --- | ||
|
|
||
| ## Goals | ||
|
|
||
| The goal is a create a simple tutorial on how to download and set up the documentation project, alogn with its dependencies. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Basic knowledge of using the terminal/command line | ||
| - Git installed on **your** system | ||
| - Internet connection | ||
|
|
||
| ## Step 1: Install Node.js | ||
|
|
||
| 1. Go to the official [Node.js website](https://nodejs.org/). | ||
| 2. Download the **LTS (Long Term Support)** version for your operating system. | ||
| 3. Run the installer and follow the setup instructions. | ||
| 4. Verify the installation by opening a terminal and running: | ||
| ```bash | ||
| node -v | ||
| npm -v | ||
| ``` | ||
| You should see the installed versions of Node.js and npm (Node Package Manager). | ||
|
|
||
| ## Step 2: Clone the Project | ||
| 1. Go to this repository: https://github.com/thoth-tech/documentation and click Fork to create your own copy. | ||
| 2. Open a terminal/command prompt. | ||
| 3. Navigate to the folder where you want the project to be saved. | ||
| 4. Run the following command: | ||
| ```bash | ||
| git clone <repository-url> | ||
| ``` | ||
| 5. Navigate into the project folder: | ||
| ```bash | ||
| cd documentation-project | ||
| ``` | ||
|
|
||
| ## Step 3: Install Dependencies | ||
|
|
||
| 1. Inside the project folder, run: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
| 2. This will install all required dependencies listed in the `package.json` file. | ||
|
|
||
| ## Step 4: Run the Project | ||
|
|
||
| 1. Start the local development server by running: | ||
| ```bash | ||
| npm run dev | ||
| ``` | ||
| 2. Open your browser and go to `http://localhost:4321` (or the URL provided in your terminal). | ||
| 3. You should now see the documentation project running. | ||
|
|
||
| ## Step 5: Make Changes or Create New Documents | ||
|
|
||
| 1. To update existing documentation or create new documents, add or modify Markdown (`.md`) files in the project. | ||
| 2. Save your changes and verify them by running the local server again: | ||
| ```bash | ||
| npm run dev | ||
| ``` | ||
| 3. Build the project to ensure there is no error | ||
| ```bash | ||
| npm run build | ||
| ``` | ||
| 4. Commit your changes using Git: | ||
| ```bash | ||
| git add . | ||
| git commit -m "Updated or added documentation" | ||
| git push origin main | ||
| ``` | ||
|
|
||
| ## Step 6: Create a Pull Request | ||
| 1. Go to your forked repository on GitHub. | ||
| 2. Click the Compare & pull request button. | ||
| 3. Review your changes and ensure they are ready to merge. | ||
| 4. Add a descriptive title and optional comments for the pull request. | ||
| 5. Click Create pull request to submit your changes for review. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please spell check this document and ensure the same spacing is used between headings and content. The content itself is well written and informative. Good work. Will pre-approve.