Skip to content

Conversation

@dcalhoun
Copy link
Member

@dcalhoun dcalhoun commented Jan 6, 2026

What?

Reorganize documentation. Expand documentation to cover integrating GutenbergKit into a native host app.

Why?

Splitting the large, existing docs/architecture.md file into a few files focused in individual subjects improves approachability and better surfaces important information.

How?

  • Reduce the README.md file contents to a link to various subject files.
  • Replace the docs/architectured.md file with multiple files focused on specific subjects.
  • Document the basics of integrating GutenbergKit into a native host app.

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.

@dcalhoun dcalhoun added the [Type] Developer Documentation Documentation for developers label Jan 6, 2026
@dcalhoun dcalhoun marked this pull request as ready for review January 6, 2026 11:04
@dcalhoun dcalhoun requested a review from nbradbury January 6, 2026 11:04
@dcalhoun dcalhoun enabled auto-merge (squash) January 6, 2026 11:04
@nbradbury nbradbury self-assigned this Jan 6, 2026
@nbradbury
Copy link
Contributor

@dcalhoun The Key Components section has just TBD for Kotlin. That doesn't appear to be something done in this PR, but I'm wondering if it needs to be updated?

@dcalhoun
Copy link
Member Author

dcalhoun commented Jan 6, 2026

@nbradbury I suggest updating that documentation within #260 or after its merge, as it is defining said key components.

Copy link
Contributor

@nbradbury nbradbury left a 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! :shipit:

@dcalhoun dcalhoun merged commit 1804cd0 into trunk Jan 6, 2026
12 checks passed
@dcalhoun dcalhoun deleted the docs/expand-documentation branch January 6, 2026 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants