You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With the widespread use of module federation in large teams and organizations, we urgently need module documentation to provide users with module usage instructions, which is very important for efficient circulation of modules in large teams. Therefore, we will open source module documentation capabilities to help community users provide clear documentation and usage demos for module users, so that modules can be used efficiently.
In our vision, we will provide users with the following capabilities:
Extract type definitions from the exposes module by default and generate API documentation
Provide document module using mdx format
Support user to write module use demo
Provide playground rendering user-provided module demos and support consuming other remote modules in demos
Support remote module version debugging
If you have more abilities that need to be implemented, leaving a comment below will be welcomed
Clear and concise description of the problem
Description
With the widespread use of module federation in large teams and organizations, we urgently need module documentation to provide users with module usage instructions, which is very important for efficient circulation of modules in large teams. Therefore, we will open source module documentation capabilities to help community users provide clear documentation and usage demos for module users, so that modules can be used efficiently.
In our vision, we will provide users with the following capabilities:
If you have more abilities that need to be implemented, leaving a comment below will be welcomed
Suggested solution
Alternative
No response
Additional context
No response
Validations
The text was updated successfully, but these errors were encountered: