Update the docs - #26
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Reorganizes and clarifies documentation for the runtime and JVM test harness.
Changes:
- Restructures README guidance and adds unreleased changelog entries.
- Improves public API KDoc.
- Shortens implementation and test comments.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
README.md |
Reorganizes usage and lifecycle guidance. |
CHANGELOG.md |
Documents unreleased fixes. |
.claude/skills/molecule-viewmodel/SKILL.md |
Updates presenter guidance. |
UiFactory.kt |
Clarifies KDoc. |
MoleculeViewModel.kt |
Revises API and implementation comments. |
MoleculePresenter.kt |
Clarifies interface contracts. |
LaunchedEffectNotNull.kt |
Documents cancellation behavior. |
MoleculeTestHarness.kt |
Improves harness KDoc. |
ProductionContractTest.kt |
Shortens test comments. |
PresenterFailureTest.kt |
Removes redundant comments. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The README starts with quick start and installation, then the rules for models, events, and effects. KDoc describes behavior instead of repeating signatures. Comments are shorter. The changelog has an unreleased section for the startup fixes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The docs grew section by section and it showed. The README explained features in the order they were built, KDoc repeated signatures, and the changelog had nothing for the unreleased fixes.
Changes