Files
DocsGPT/docs
arc53-machine a8dab8864d refactor(settings): validate cross-field rules in the model
The "AUTH_TYPE=oidc requires OIDC_ISSUER, OIDC_CLIENT_ID and
OIDC_FRONTEND_URL" check lived in app.py, so it only ran when the Flask
app was imported; a worker or script with the same misconfiguration
started fine. It is now a model validator on the auth group and runs
wherever Settings is loaded, with the same message.

DEPLOYMENT_TYPE, which app.py read straight from the environment to
decide whether a missing JWT_SECRET_KEY is fatal, is a documented
setting on the server group now, so it shows up in the reference like
every other variable the app reads.
2026-09-17 11:09:09 +01:00
..
2026-06-26 11:56:20 +04:00

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:3000. 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.