Currently all documentation for @microsoft/fast-tooling and @microsoft/fast-tooling-react is located in their package README.md files. This poses a few problems:
The documentation is difficult to parse as it can become quite long
It is difficult to create working inline examples as part of the documentation
Design has no documentation in the README.md file as to how the UI should look
The packages work very closely together, thereby making traversing separate package README.md files cumbersome to understand the entire ecosystem
Given the above issues and the growing complexity of the distributed packages in FAST Tooling, it would be ideal to have a documentation site dedicated to the project.
Requirements
The documentation site should be able to:
Support multiple versions so that users locked to specific versions need not upgrade right away
Run locally and should be part of this repository to ensure versioning is correct for distributed packaged
Be tested for basic run time errors (with more complex testing added ad hoc moving forward)
Be distributed when a package publish is triggered
Include design specifications and use cases for generated UI (such as the React and Web components)
Include TypeDocs or other TypeScript generated documentation
Description
Currently all documentation for
@microsoft/fast-toolingand@microsoft/fast-tooling-reactis located in their packageREADME.mdfiles. This poses a few problems:README.mdfile as to how the UI should lookREADME.mdfiles cumbersome to understand the entire ecosystemGiven the above issues and the growing complexity of the distributed packages in FAST Tooling, it would be ideal to have a documentation site dedicated to the project.
Requirements
The documentation site should be able to: