From 7b28d353ee010bfc5299d3f49e03ce08dc2dd52d Mon Sep 17 00:00:00 2001 From: dhselar1423 Date: Mon, 16 Oct 2023 10:57:49 +0530 Subject: [PATCH 1/3] made changes in package.json and added instructions nextra-docsgpt --- docs/package.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/package.json b/docs/package.json index 1585c0a..c740597 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,4 +1,10 @@ { +"scripts":{ + "dev": "next dev", + "build": "next build", + "start": "next start" + }, + "license": "MIT", "dependencies": { "@vercel/analytics": "^1.0.2", "docsgpt": "^0.2.4", @@ -8,4 +14,4 @@ "react": "^18.2.0", "react-dom": "^18.2.0" } -} +} \ No newline at end of file From 74ff9942815f95f5efda4cdf4594a3ab115403c2 Mon Sep 17 00:00:00 2001 From: dhselar1423 Date: Mon, 16 Oct 2023 10:59:25 +0530 Subject: [PATCH 2/3] nextra-docsGPT local setup --- docs/README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 5b0ef6a..ae81999 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,70 @@ -# nextra-docsgpt \ No newline at end of file +# nextra-docsgpt + +## Setting Up Docs Folder of DocsGPT Locally + +### 1. Clone the DocsGPT repository: + +commandline + +``` +git clone https://github.com/arc53/DocsGPT.git + +``` + +### 2. Navigate to the docs folder: + +commandline + +``` +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: + +`index.mdx`: The main documentation file. +`_app.js`: This file is used to customize the default Next.js application shell. +`theme.config.jsx`: This file is for configuring the Nextra theme for the documentation. + +### 3. Verify that you have Node.js and npm installed in your system. You can check by running: + +commandline + +``` +node --version +npm --version + +``` + +### 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: + +commandline + +``` +npm install --global yarn + +``` + +### 6. Install the project dependencies using yarn: + +commandline + +``` +yarn install + +``` + +### 7. After the successful installation of the project dependencies, start the local server: + +commandline + +``` +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. + +- Footnotes: This guide assumes you have Node.js and npm installed. The guide involves running a local server using yarn, and viewing the documentation offline. If you encounter any issues, it may be worth verifying your Node.js and npm installations and whether you have installed yarn correctly. From f886dfb60ca236c0bcd289d7a017fa9f43c2b8e3 Mon Sep 17 00:00:00 2001 From: dhselar1423 Date: Mon, 16 Oct 2023 23:28:39 +0530 Subject: [PATCH 3/3] removed commandline --- docs/README.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/README.md b/docs/README.md index ae81999..8958f6d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,22 +4,16 @@ ### 1. Clone the DocsGPT repository: -commandline - ``` git clone https://github.com/arc53/DocsGPT.git ``` - ### 2. Navigate to the docs folder: -commandline - ``` 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: `index.mdx`: The main documentation file. @@ -28,38 +22,27 @@ 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: -commandline - ``` node --version npm --version ``` - ### 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: -commandline - ``` npm install --global yarn ``` - ### 6. Install the project dependencies using yarn: -commandline - ``` yarn install ``` - ### 7. After the successful installation of the project dependencies, start the local server: -commandline - ``` yarn dev