The project has a Developer Guide defined under packages/docs and implemented as an interactive website using the Docusaurus platform.
- Read the website/README for more details on setting up and building this package.
- Use the following instructions for a quickstart.
$ cd packages/docs/website # Set working directory
$ npm install # Install dependencies
$ npm run start # Run dev server, launch preview
..
[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/This should launch the browser to the landing page of the guide as shown below:
This repo is not configured for automated deployment of the website to a static site hosting service. However Docusaurus provides Deployment guidance that works for most options - we've validated this for Azure Static Web Apps and GitHub Pages.
If you want a hosted version of the guide, we recommend you maintain a personal fork and set it up for automated build-deploy with GitHub Actions. Then keep up-to-date with origin, for content.
- See this personal fork for a working example for reference
- Visit this GitHub Pages endpoint to see the associated live deployment.
- Note that this example may not always reflect the latest repo changes in content.
The website comes with its own Playwright testing harness with a separate configuration and a base test specification. Use it for test-driven documentation to validate the existence of routes and sections, and check content for accessibility compliance. Note - this test suite is separate from e2e testing setup for Contoso Real Estate application (located in packages/testing).
- Learn more about test setup in website/README.TESTING.md.
- Use the following instructions for a quickstart.
$ cd packages/docs/website # Set working directory
$ npm install # Install dependencies
$ npm run test # Run dev server => launches browser to preview
$ npm run report # View last HTML report => open browser to specified URLWant to understand what the test report provides? You can explore this cached version of the report interactively (screenshot below) to dive into detailed traces. Note that the cached version will not reflect the latest codebase updates and is meant only as an example.
