Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 0
Bump dependencies and adjust Maven coordinates#12
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
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
291bab310e7f4b09eb7e61e47e7fc59f12c749514bc8e16d7288c99aFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| 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`. | ||
| 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." | ||
| 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. | ||
| 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() | ||
| * ``` | ||
| */ | ||
| ```` |
| 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 >}} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.