From 82b680a6d9ac791900cb0c5d6563feab73b8b27f Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Thu, 26 Sep 2024 10:48:13 -0700 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b336a64..88fd3a2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # ProjectDiscovery Documentation

- This is the source code for the ProjectDiscovery documentation located at https://docs.projectdiscovery.io + This is the source code for the ProjectDiscovery documentation located at https://docs.projectdiscovery.io.

@@ -19,26 +19,24 @@ --- -## Development +## Build docs locally -1. Checkout this repository -1. Install mintlify with `npm i -g mintlify@latest` -1. Run `mintlify dev` +1. Fork this repository. +1. Install mintlify with `npm i -g mintlify@latest`. +1. Run `mintlify dev`. ## Deploying -To build the final product, we have a couple of additional steps: +To build the final product: -1. Build the JS Protocol Docs +1. Build the JS Protocol Docs: - `npm install -g jsdoc-to-markdown` - `./bin/jsdocs.sh` -2. Build the PDCP API reference documentation +2. Build the PDCP API reference documentation: - Either download the latest `openapi.yaml` manually or run `./bin/download-api.sh` - Run `./bin/generate-api.sh` to generate any new API files -3. Deployment - -After those, Mintlify handles the deployment automatically. \ No newline at end of file +3. Mintlify handles the deployment automatically.