You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

dependabot[bot] 340dcfb70d build(deps): bump tar and npm in /docs Removes [tar](https://github.com/isaacs/node-tar). It's no longer used after updating ancestor dependency [npm](https://github.com/npm/cli). These dependencies need to be updated together. Removes `tar` Updates `npm` from 10.5.0 to 10.5.1 - [Release notes](https://github.com/npm/cli/releases) - [Changelog](https://github.com/npm/cli/blob/latest/CHANGELOG.md) - [Commits](https://github.com/npm/cli/compare/v10.5.0...v10.5.1) --- updated-dependencies: - dependency-name: tar dependency-type: indirect - dependency-name: npm dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>		4 weeks ago
..
pages	Add prompt_id and chunks fields in create_api_key function	4 weeks ago
public	fix	6 months ago
README.md	Update README.md	6 months ago
next.config.js	Bump dependencies & support next 14 for docs	4 months ago
package-lock.json	build(deps): bump tar and npm in /docs	4 weeks ago
package.json	docs: updated version	2 months ago
theme.config.jsx	different imports	8 months ago

README.md

nextra-docsgpt

Setting Up Docs Folder of DocsGPT Locally

1. Clone the DocsGPT repository:

git clone https://github.com/arc53/DocsGPT.git

2. Navigate to the docs folder:

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:

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:

npm install --global yarn

6. Install the project dependencies using yarn:

yarn install

7. After the successful installation of the project dependencies, start the local server:

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.