Welcome to LambdaTest's documentation repository! Help us enhance our documentation by contributing—whether it's fixing a typo or adding new topics. We appreciate all contributions.
We recommend forking the repo, creating all content changes in branches, and submitting pull requests. We will work with you to get this content reviewed, tested, and merged for publishing.
Docusaurus requires the following to build on locals:
- NodeJS version recommended: 16.14.0)
- Verify the Node.js version by opening Command Prompt/Terminal and running node -v
- Download Git here
- VS Code Editor
To build on your local:
- Clone the repo using Git or tools like GitHub Desktop.
- In a terminal, change to the cloned repo folder. Run the install command:
npm install. - To serve and review your content, use one of the following:
- Use start, hot reloads as you make changes:
npm start.
- Use start, hot reloads as you make changes:
- To build locally and test your links, run
npm run build. Any issues with broken links and images are listed according to file. Locate and update those issues, then runnpm serveand start again to verify.
Note- If the command doesn't work, try npm i react-scripts@latest followed by npm start.
The static files are generated in the build folder and run on your local machine at: http://localhost:3000/. To stop the build or served site, hit Ctrl + C to interrupt. You can enter new commands in terminal, rebuild, and restart.
LambdaTest Documentation was created using Docusaurus 2 with React
As pull requests are merged to the main branch by the LambdaTest Documentation team, the content builds and deploys to a staging site. This allows you to review and test your content thoroughly on a server, rather than a local build, prior to merging your code to production.