-
Notifications
You must be signed in to change notification settings - Fork 3
Bump dependencies and add Writer skill #622
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| name: writer | ||
| description: Write, edit, and restructure user-facing and developer-facing documentation. Use when asked to create/update docs such as `README.md`, `docs/**`, and other Markdown documentation; when drafting tutorials, guides, troubleshooting pages, or migration notes; and when improving inline API documentation (KDoc) and examples. | ||
| --- | ||
|
|
||
| # Write documentation (repo-specific) | ||
|
|
||
| ## Decide the target and audience | ||
|
|
||
| - Identify the target reader: end user, contributor, maintainer, or tooling/automation. | ||
| - Identify the task type: new doc, update, restructure, or documentation audit. | ||
| - Identify the acceptance criteria: “what is correct when the reader is done?” | ||
|
|
||
| ## Choose where the content should live | ||
|
|
||
| - Prefer updating an existing doc over creating a new one. | ||
| - Place content in the most discoverable location: | ||
| - `README.md`: project entry point and “what is this?”. | ||
| - `docs/`: longer-form docs (follow existing conventions in that tree). | ||
| - Source KDoc: API usage, examples, and semantics that belong with the code. | ||
|
|
||
| ## Follow local documentation conventions | ||
|
|
||
| - Follow `.agents/documentation-guidelines.md` and `.agents/documentation-tasks.md`. | ||
| - Use fenced code blocks for commands and examples; format file/dir names as code. | ||
| - Avoid widows, runts, orphans, and rivers by reflowing paragraphs when needed. | ||
|
|
||
| ## Make docs actionable | ||
|
|
||
| - Prefer steps the reader can execute (commands + expected outcome). | ||
| - Prefer concrete examples over abstract descriptions. | ||
| - Include prerequisites (versions, OS, environment) when they are easy to miss. | ||
| - Use consistent terminology (match code identifiers and existing docs). | ||
|
|
||
| ## KDoc-specific guidance | ||
|
|
||
| - For public/internal APIs, include at least one example snippet demonstrating common usage. | ||
| - When converting from Javadoc/inline comments to KDoc: | ||
| - Remove HTML like `<p>` and preserve meaning. | ||
| - Prefer short paragraphs and blank lines over HTML formatting. | ||
|
|
||
| ## Validate changes | ||
|
|
||
| - For code changes, follow `.agents/running-builds.md`. | ||
| - For documentation-only changes in Kotlin/Java sources, prefer `./gradlew dokka`. | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| interface: | ||
| display_name: "Writer" | ||
| short_description: "Write and update user/developer docs" | ||
| default_prompt: "Write or revise documentation in this repository (for example: README.md, docs/**, CONTRIBUTING.md, and API documentation/KDoc). Follow local documentation guidelines in .agents/*.md, keep changes concise and actionable, and include concrete examples and commands where appropriate." | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Title | ||
|
|
||
| ## Goal | ||
|
|
||
| State what the reader will accomplish. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - List versions/tools the reader needs. | ||
|
|
||
| ## Steps | ||
|
|
||
| 1. Do the first thing. | ||
| 2. Do the next thing. | ||
|
|
||
| ## Verify | ||
|
|
||
| Show how the reader can confirm success. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - Common failure: likely cause → fix. | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ````kotlin | ||
| /** | ||
| * Explain what this API does in one sentence. | ||
| * | ||
| * ## Example | ||
| * ```kotlin | ||
| * // Show the typical usage pattern. | ||
| * val result = doThing() | ||
| * ``` | ||
| */ | ||
| ```` |
13 changes: 13 additions & 0 deletions
13
.agents/skills/writer/assets/templates/kotlin-java-example.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| {{< code-tabs langs="Kotlin, Java">}} | ||
|
|
||
| {{< code-tab lang="Kotlin" >}} | ||
| ```kotlin | ||
| ``` | ||
| {{< /code-tab >}} | ||
|
|
||
| {{< code-tab lang="Java" >}} | ||
| ```java | ||
| ``` | ||
| {{< /code-tab >}} | ||
|
|
||
| {{< /code-tabs >}} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
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
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
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
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.
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.
setFreeCompilerArgs()now sets JVM default mode only whenthis is KotlinJvmCompilerOptions, but inbuildSrc/src/main/kotlin/kmp-module.gradle.ktsthis helper is invoked from the top-levelcompilerOptions {}block (common options) and not in thejvm { compilerOptions {} }block. As a result, multiplatform JVM compilations lose the previous-Xjvm-default=allbehavior and will emit different interface-method bytecode, which can break binary compatibility for published KMP JVM artifacts consumed from Java/Kotlin.Useful? React with 👍 / 👎.