### Downloading GitHub Desktop
- **Why Use GitHub Desktop?**: Offers a more convenient and faster onboarding experience for those without advanced git knowledge. Eliminates the need for command line usage.
- **Download Link**: [GitHub Desktop](https://desktop.github.com/)
- **Resources**:
- [Introduction to GitHub Desktop](https://youtu.be/l7uo1d3R0Wo)
- [Basic Concepts of Git](https://youtu.be/JlpRfMRWNY8)

### Clone Jan into Your Desktop
- Login to GitHub Desktop with your Git Account and clone repo janhq/jan
- First, your current branch is the `main` branch. Thus, when you want to solve any issue, you need to change your branch into new branch, e.g. docs/..... docs/add-install-model-from-hub
+ GitHub Desktop Documentaion: https://docs.github.com/en/desktop
+ How to Create a new branch: https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop
+ Git Commit Guideline: https://ec.europa.eu/component-library/v1.15.0/eu/docs/conventions/git/
- Then, you double click to Current repository and Open in Visual Studio Code

### Documentation Structure
- On Jan repository, our documentation is in the /docs folder
- The details information of docs folder can be view via this https://github.com/janhq/jan/tree/main/docs
- This documentation also mentioned detailed information about each part `guide`, `developer`, `api-reference`, `docs`, etc

### Install Docs folder
- Our documentation is based on Docusaurus library: https://docusaurus.io/docs/
- In general, our documentation is already configured most libraries, if you need any additional library, feel free to let me know. I add these new extension.

- Prerequisite install node.js https://nodejs.org/en/download
- Install yarn by `npm install --global yarn` https://classic.yarnpkg.com/lang/en/docs/install/#mac-

- Open the docs folder on Visual Studio Code and we need to install all dependency for running website, please type the following command in the terminalstable
- `yarn`
- `yarn start`
- Then, screen should show`[SUCCESS] Docusaurus website is running at: http://localhost:3001/`

### Modifying the Documentation
- **Editing Content**:
- Documentation can be modified in the `.mdx` files.
- **Reminders**:
- Images should be placed in the `assets` folder for each section, e.g., [Assets Folder Example](https://github.com/janhq/jan/tree/main/docs/docs/guides/04-using-models).
- Pages should be indexed with a number and title, like `01-install-from-hub.mdx`, for sidebar sorting.
- Follow the structure in existing `.mdx` files: `title`, `slug`, `description`, `keywords` (e.g., [MDX File Structure Example](https://github.com/janhq/jan/blob/main/docs/docs/guides/04-using-models/02-import-manually.mdx)).

### Finalizing the Documentation
- **Formatting**: Right-click the source code in Visual Studio Code and select 'Format Document' to ensure proper structure and format.
- **Committing Changes**:
- Write a commit message in GitHub Desktop and push your changes to your branch.
- Create a pull request from your branch to the main branch. Fill in the sections in the Pull Request Template and add details like `reviewer`, `sprint`, `assignees`, etc., as demonstrated in the meeting.
- **Review Process**:
- After the reviewer approves your pull request, you can merge it. Address any change requests from the reviewer before final approval.

- *Merge Pull Request*
- When your pull request is approved, you can merged it directly to main branch
- Suggestion: Please following this style for commit message when merging 

Feel free to ping me any time, when you're having an technical issue or need a support.