LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-11-29 08:33:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Roman Bug
2023-10-30 00:59:17 +03:00
committed by GitHub
parent 46817c7664
commit a74c70e8a1
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/README.md
View File

@@ -4,16 +4,15 @@
### 1. Clone the DocsGPT repository: ### 1. Clone the DocsGPT repository:
``` ```bash
git clone https://github.com/arc53/DocsGPT.git git clone https://github.com/arc53/DocsGPT.git
``` ```
### 2. Navigate to the docs folder: ### 2. Navigate to the docs folder:
``` ```bash
cd DocsGPT/docs cd DocsGPT/docs
``` ```
The docs folder contains the markdown files that make up the documentation. The majority of the files are in the pages directory. Some notable files in this folder include: The docs folder contains the markdown files that make up the documentation. The majority of the files are in the pages directory. Some notable files in this folder include:
`index.mdx`: The main documentation file. `index.mdx`: The main documentation file.
@@ -22,30 +21,29 @@ The docs folder contains the markdown files that make up the documentation. The
### 3. Verify that you have Node.js and npm installed in your system. You can check by running: ### 3. Verify that you have Node.js and npm installed in your system. You can check by running:
``` ```bash
node --version node --version
npm --version npm --version
``` ```
### 4. If not installed, download Node.js and npm from the respective official websites. ### 4. If not installed, download Node.js and npm from the respective official websites.
### 5. Once you have Node.js and npm running, proceed to install yarn - another package manager that helps to manage project dependencies: ### 5. Once you have Node.js and npm running, proceed to install yarn - another package manager that helps to manage project dependencies:
``` ```bash
npm install --global yarn npm install --global yarn
``` ```
### 6. Install the project dependencies using yarn: ### 6. Install the project dependencies using yarn:
``` ```bash
yarn install yarn install
``` ```
### 7. After the successful installation of the project dependencies, start the local server: ### 7. After the successful installation of the project dependencies, start the local server:
``` ```bash
yarn dev yarn dev
``` ```
- Now, you should be able to view the docs on your local environment by visiting `http://localhost:5000`. You can explore the different markdown files and make changes as you see fit. - Now, you should be able to view the docs on your local environment by visiting `http://localhost:5000`. You can explore the different markdown files and make changes as you see fit.