-
Notifications
You must be signed in to change notification settings - Fork 3
docs: Expand and organize documentation #273
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
Conversation
Organize separate subjects.
Some may not recognize Gutenberg.
Mitigate stale documentation.
|
@dcalhoun The Key Components section has just |
|
@nbradbury I suggest updating that documentation within #260 or after its merge, as it is defining said key components. |
nbradbury
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for doing this! ![]()
What?
Reorganize documentation. Expand documentation to cover integrating GutenbergKit into a native host app.
Why?
Splitting the large, existing
docs/architecture.mdfile into a few files focused in individual subjects improves approachability and better surfaces important information.How?
README.mdfile contents to a link to various subject files.docs/architectured.mdfile with multiple files focused on specific subjects.Testing Instructions
Browse the new documentation on GitHub for mistakes.
Stepping through each commit may also help comprehend the changes and the intent behind them.
Accessibility Testing Instructions
N/A, no functional changes.
Screenshots or screencast
N/A, no visual changes.