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.

Sign up for GitHub

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

Jump to bottom

Rework documentation #16

Open
yeegor opened this issue Apr 27, 2021 · 1 comment
Open

Rework documentation #16

yeegor opened this issue Apr 27, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@yeegor
Copy link
Contributor

yeegor commented Apr 27, 2021

Overview

Documentation is bad. Make it good.

Comments:

  1. Remove preference and provision documentation -> move to "experimental"
  2. Step-by-step guides for integrations
  3. Common props and other NextJS-specific documentation (pages)
  4. Deeper split the documentation into blocks, especially about the plugin system
  5. Separate "hands-on" tutorial section and section with pure theory
  6. Micro-frontend tutorial cycle
  7. Examples of projects built on this technology
  8. Registering a plugin -> where does the namespace come from? The handler type?

Inspire from README, it is good!
@yeegor yeegor added the documentation Improvements or additions to documentation label Apr 28, 2021
@yeegor
Copy link
Contributor Author

yeegor commented May 14, 2021

The documentation has been updated some time ago. The next changes should be related to explaining "The Mosaic Way", with all of our framework-ish stuff like sortedRenderMap etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@yeegor