This PR updates the API documentation in the following way:
Every seperate package in the monorepo creates its own API documentation site using docfx
The root contains a set of textual documentation pages (the one we already had, nothing new here)
We merge them together in a single output folder to integrate the seperate micro-documentation-sites and make it feel like it's a single docs site.
The reason we need to it like this is because we are using the same namespace (Auth0.OidcClient) for all packages, which contain classes with the exact same name. Docfx does not support that and will throw away all duplicates, resulting in loss of documentation.
This can be solved in two solutions:
Micro-api-docs sites like in this PR
A breaking change to ensure every package has its own namespace. This is a breaking change and we decided to move forward with the first approach, as implemented in this PR.
Changes
This PR updates the API documentation in the following way:
The reason we need to it like this is because we are using the same namespace (
Auth0.OidcClient) for all packages, which contain classes with the exact same name. Docfx does not support that and will throw away all duplicates, resulting in loss of documentation.This can be solved in two solutions:
Before:
After:
Checklist