Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add support for Monorepo project docs generation #1111

Open
maschad opened this issue Nov 29, 2022 · 0 comments
Open

Docs: Add support for Monorepo project docs generation #1111

maschad opened this issue Nov 29, 2022 · 0 comments

Comments

@maschad
Copy link
Contributor

maschad commented Nov 29, 2022

Following up on the conversation here we should work out a way to handle generating docs for monorepos.

TypeDoc's entryPointStrategy: packages is dedicated support for monorepo projects, it will attempt to determine entry points based on package.json's main property (with default value index.js) and if it wasn't found, based on types property.

For most for aegir-managed projects monorepos seem to have the projects listed under the packages directory, we could default to this and use the packages entryPointStrategy and pass the paths.

Otherwise we could have an optional monoRepoEntryPoints flag that a user could pass as an argument and then we pass that to the entryPointStrategy argument.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant