continue icon indicating copy to clipboard operation
continue copied to clipboard

Updated running the doc server locally

Open shermanhuman opened this issue 1 year ago • 1 comments

Description

CONTRIBUTING.md

  • changed 'navigate to project root directory' to 'navigate to docs subdirectory'

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.

  • Added 'npm install' to instructions

This is required for new installs, right?

package.json

  • Changed npm start script to use double quotes for Windows compatibility

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

Checklist

  • [x] The base branch of this PR is dev, rather than main
  • [x] The relevant docs, if any, have been updated or created

Testing

  • Viewed CONTRIBUTING doc in browser on my fork.
  • Tested 'npm run start' in Windows 11 and MacOS Sonoma environments.

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 avatar Sep 24 '24 23:09 shermanhuman

Hey there! Love the changes to CONTRIBUTING.md, will help others contribute much more easily. It looks like some changes from your other PR got squeezed into this one—I would just let it go if we were going to merge anyway, but I think we want not to include the large logos in the install pages. Any chance you could split up the changes so we can merge the CONTRIBUTING.md stuff here?

sestinj avatar Sep 26 '24 02:09 sestinj

Yeah, sorry, I'm new to this. I didn't realize I should have a clean branch for each PR. I'll close both PRs and try again.

shermanhuman avatar Sep 28 '24 03:09 shermanhuman