Problem Solved By The Feature

We have a lot of existing documentation in Markdown files scattered throughout the source code.

We want to provide easy access to all documentation for the entire RxAngular community and ecosystem.

Solution

• Move all Markdown files to the docs project.
• Transclude CONTRIBUTING.md and package README.mds
• List transcluded Markdown files as implicit Nx dependencies for the docs project

alternatives Considered

Docusaurus can only reference Markdown files in its own project folder. Markdown transclusion is the only workaround for this that supports auto-generating the table of contents on the right-hand side of the page on large screens.

nx affected commands probably won't detect changes in transcluded Markdown files so moving Markdown files to the docs project is preferred over Markdown transclusion.

Additional Context

Beware of images and Markdown files linked directly on GitHub from README.md files published with the library.

Use Markdown transclusion for CONTRIBUTING.md and README.md files as in this example [raw] [credits].