continuedev / continue

⏩ Continue is the leading open-source AI code assistant. You can connect any models and any context to build custom autocomplete and chat experiences inside VS Code and JetBrains
https://docs.continue.dev/
Apache License 2.0
19.25k stars 1.66k forks source link

Updates to running the doc server locally #2382

Closed shermanhuman closed 1 month ago

shermanhuman commented 1 month ago

Description

CONTRIBUTING.md

It seems like the process has changed, since you can't run npm from the root directory, there's no package.json there. So I updated the instructions to start from the 'doc' subdir.

This is required for new installs, right?

package.json

'nodemon' has some limitations using --exec on windows. Double quotes are required for Windows users.

Checklist

Testing

Follow the instructions in the updated doc to test:

  1. Open your terminal and navigate to the docs subdirectory of the project. The docusaurus.config.js file you'll see there is a sign you're in the right place.

  2. Run the following command to install the necessary dependencies for the documentation server:

    npm install
  3. Run the following command to start the documentation server:

    npm run start
shermanhuman commented 1 month ago

I didn't fork the dev branch ... let me do that and try again.