Azure Upgrade
microsoft/GitHub-Copilot-for-Azure
Assess and upgrade Azure workloads between plans, tiers, or SKUs, or modernize Azure SDK dependencies in source code.
A skill your agent uses when writing or editing Javadoc for Lettuce public API — new methods, classes, deprecations, or when a reviewer asks to fix or improve doc comments.
Install Writing Javadoc
$ npx skills add redis/lettuce --skill writing-javadoc -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install redis/lettuce writing-javadoc --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/redis/lettuce.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/writing-javadoc .claude/skills/writing-javadoc && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "writing-javadoc" agent skill from https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadoc into .claude/skills/writing-javadoc/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-javadoc", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadocType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add redis/lettuce --skill writing-javadoc -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install redis/lettuce writing-javadoc --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/redis/lettuce.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/writing-javadoc .agents/skills/writing-javadoc && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "writing-javadoc" agent skill from https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadoc into .agents/skills/writing-javadoc/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-javadoc", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add redis/lettuce --skill writing-javadoc -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install redis/lettuce writing-javadoc --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/redis/lettuce.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/writing-javadoc .cursor/skills/writing-javadoc && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "writing-javadoc" agent skill from https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadoc into .cursor/skills/writing-javadoc/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-javadoc", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/redis/lettuce.git --path .agents/skills/writing-javadoc--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add redis/lettuce --skill writing-javadoc -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install redis/lettuce writing-javadoc --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/redis/lettuce.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/writing-javadoc .gemini/skills/writing-javadoc && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "writing-javadoc" agent skill from https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadoc into .gemini/skills/writing-javadoc/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-javadoc", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install redis/lettuce writing-javadocInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add redis/lettuce --skill writing-javadoc -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/redis/lettuce.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/writing-javadoc .github/skills/writing-javadoc && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "writing-javadoc" agent skill from https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadoc into .github/skills/writing-javadoc/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-javadoc", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add redis/lettuce --skill writing-javadoc -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install redis/lettuce writing-javadoc --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/redis/lettuce.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/writing-javadoc .opencode/skills/writing-javadoc && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "writing-javadoc" agent skill from https://github.com/redis/lettuce/tree/main/.agents/skills/writing-javadoc into .opencode/skills/writing-javadoc/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-javadoc", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
writing-javadoc- GitHub stars
- 5.8k
- Token cost
- ~809 tokens
- SKILL.md length
- 321 words
- Files
- 1
- Skills in repo
- 3
- Repo updated
- First seen
- Licence
- MIT
At a glance
A skill your agent uses when writing or editing Javadoc for Lettuce public API — new methods, classes, deprecations, or when a reviewer asks to fix or improve doc comments.
- Works in 9 steps: Golden rule: document the caller-facing… → First sentence: imperative verb for… → Tag order: @param → @return → @throws →… → …
- Editing Javadoc for Lettuce public API — new methods
- SKILL.md covers Before you write, The rules most often gotten… and Verify, don't guess
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Writing Javadoc is an agent skill from redis/lettuce, published by the product's own GitHub organization. Use when writing or editing Javadoc for Lettuce public API — new methods, classes, deprecations, or when a reviewer asks to fix or improve doc comments. Points to the full house ruleset in .agents/docs/javadoc.md (imperative method summaries, fixed tag order, @param/@return/@throws/@since/@deprecated house forms) and the rule that command-interface Javadoc is written on the sync interface first and mirrored to the other flavors. Trigger on "write javadoc for", "document this method", "add a deprecation notice"…
Its SKILL.md is about 810 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Databases. It works with Redis, Java, Amazon Web Services and Microsoft Azure. The licence is MIT.
When your agent uses it
- Editing Javadoc for Lettuce public API — new methods
- A reviewer asks to fix
- Improve doc comments
- Write javadoc for
Example prompts
- “write javadoc for”
- “document this method”
- “add a deprecation notice”
- “/writing-javadoc”
Workflow steps
9 steps, taken from the first numbered list in SKILL.md.
- Golden rule: document the caller-facing contract (inputs, outputs, effects,
- First sentence: imperative verb for methods ("Append…", "Get…", "Remove…"),
- Tag order: @param → @return → @throws → @author → @since → @see
- @param for every parameter (type params / first); state
- @return for non-void; describe the value and its meaningful states, not the
- @since is a bare version — @since 7.7 (see .agents/docs/javadoc.md for deriving
- @deprecated — keep the @Deprecated annotation and the tag in sync; house
- @author on types only — the maintainer's name (an agent must not invent
- Use {@code null} for literals; {@link} only to types resolvable on the
What it can do on your machine
Read from SKILL.md and the folder at commit 0eeff0f. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Writing Javadoc loads about 809 tokens when it runs. Until then it costs about 139 tokens; SKILL.md has 321 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from redis/lettuce at commit 0eeff0f, republished under its MIT licence (© redis). 321 words, ~809 tokens.
Download SKILL.mdSave it as
.claude/skills/writing-javadoc/SKILL.md (or your agent's skills folder).- name
- writing-javadoc
- description
- Use when writing or editing Javadoc for Lettuce public API — new methods, classes, deprecations, or when a reviewer asks to fix or improve doc comments. Points to the full house ruleset in .agents/docs/javadoc.md (imperative method summaries, fixed tag order, @param/@return/@throws/@since/@deprecated house forms) and the rule that command-interface Javadoc is written on the sync interface first and mirrored to the other flavors. Trigger on "write javadoc for", "document this method", "add a deprecation notice", "fix the doc comment".
Writing Javadoc for Lettuce
The complete, authoritative ruleset is .agents/docs/javadoc.md — read it before writing. This skill is the operating checklist; the doc wins on any detail.
Before you write
Is it a command interface? The command interfaces are hand-edited, with the sync interface's Javadoc as the reference text. Write or fix the comment on the sync method first, then mirror it to every flavor that declares the method, with the flavor-appropriate
@returnphrasing (RedisFuture,Mono/Flux, …):src/main/java/io/lettuce/core/api/{sync,async,reactive}/- the Kotlin coroutine interfaces (
src/main/kotlin/…/api/coroutines/) - the cluster node-selection interfaces
(
src/main/java/io/lettuce/core/cluster/api/{sync,async}/NodeSelection…) - the Sentinel interfaces (
src/main/java/io/lettuce/core/sentinel/api/…and their Kotlin flavor)
Javadoc parity is not test-enforced — keep the flavors in sync by hand. See api-consistency.md.
The rules most often gotten wrong
- Golden rule: document the caller-facing contract (inputs, outputs, effects, errors, nullability) — never implementation details or refactor rationale.
- First sentence: imperative verb for methods ("Append…", "Get…", "Remove…"), noun phrase for types. Not "This method…". Ends in a clean period.
- Tag order:
@param→@return→@throws→@author→@since→@see→@deprecated. @paramfor every parameter (type params<K>/<V>first); state nullability with the house phrasesmust not be {@code null}./can be {@code null}.@returnfor non-void; describe the value and its meaningful states, not the type.@sinceis a bare version —@since 7.7(see .agents/docs/javadoc.md for deriving the version from the build).@deprecated— keep the@Deprecatedannotation and the tag in sync; house form:@deprecated since <version>, use {@link Replacement} instead; scheduled for removal in a future major release.@authoron types only — the maintainer's name (an agent must not invent one); don't reorder existing authors.- Use
{@code null}for literals;{@link}only to types resolvable on the compile classpath (else{@code TypeName}).
Verify, don't guess
Match the surrounding file, and consult .agents/docs/javadoc.md for any subtle case
rather than inventing a rule. Javadoc lint is off in the build (<doclint>none</doclint>),
so review is the only check — get it right by hand.
© redis, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/writing-javadoc of redis/lettuce.
Open the folder on GitHubat commit 0eeff0f
Compare with similar skills
Writing Javadoc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Writing Javadoc this skillredis/lettuce | 5.8k | — | ~809 | Automated safety check: Pass | MIT | |
| Azure Upgrademicrosoft/GitHub-Copilot-for-Azure | 255 | 1 repos | ~1.5k | Automated safety check: Pass | MIT | |
| FoundatioFoundatioFx/Foundatio | 2.1k | — | ~3.9k | Automated safety check: Pass | Apache-2.0 | |
| Create Spring Boot Kotlin Projectgithub/awesome-copilot | 40k | 1 repos | ~1k | Automated safety check: Pass | MIT | |
| Heroku To AWSaws/agent-toolkit-for-aws | 2.8k | — | ~7.2k | Automated safety check: Pass | Apache-2.0 | |
| Ak Cloud Deployyaalalabs/agent-kernel | 192 | — | ~14k | Automated safety check: Pass | Apache-2.0 |
Similar skills
- Official
Foundatio
FoundatioFx/Foundatio
A skill your agent uses when working with Foundatio infrastructure abstractions for .NET -- caching, queuing, messaging, file storage, distributed locking, or background jobs.
- Official
Create Spring Boot Kotlin Project
github/awesome-copilot
Create Spring Boot Kotlin Project Skeleton. An agent skill from github/awesome-copilot.
- Official
Heroku To AWS
aws/agent-toolkit-for-aws
Migrate workloads from Heroku to AWS. An agent skill from aws/agent-toolkit-for-aws.
Ak Cloud Deploy
yaalalabs/agent-kernel
Deploy an Agent Kernel project to AWS, Azure, or GCP using Terraform modules, or to any Kubernetes cluster (on-prem, baremetal, EKS) using the official Helm chart.
- Official
Produce Jedis's implementation plan for a Redis API change from a shared client HLD - one reviewed markdown file naming the public API to add, every file and surface to touch, the ordered steps, the…
More from redis/lettuce
- Official
Create Implementation Plan For Redis API Change
redis/lettuce
Produce Lettuce's implementation plan for a Redis API change from a shared client HLD - one reviewed markdown file naming the public API to add, every file and flavor to touch, the ordered steps…
- Official
Extend Commands API
redis/lettuce
Add or extend Redis commands in the Lettuce client API end-to-end — a new core command, a family of new commands, an extension to an existing command's options, or a module/area command…
Related
Categories
Questions about Writing Javadoc
What does Writing Javadoc do?
A skill your agent uses when writing or editing Javadoc for Lettuce public API — new methods, classes, deprecations, or when a reviewer asks to fix or improve doc comments. Writing Javadoc is an agent skill from redis/lettuce, published by the product's own GitHub organization. Use when writing or editing Javadoc for Lettuce public API — new methods, classes, deprecations, or when a reviewer asks to fix or improve doc comments.
When should I use Writing Javadoc?
Writing Javadoc fits situations like: editing Javadoc for Lettuce public API — new methods; A reviewer asks to fix; improve doc comments; write javadoc for.
How do I install Writing Javadoc in Claude Code?
Run `npx skills add redis/lettuce --skill writing-javadoc -a claude-code`. Or copy the skill folder (.agents/skills/writing-javadoc in redis/lettuce) into .claude/skills/writing-javadoc in your project. Claude Code loads it when a task matches its description.
How do I install Writing Javadoc in Codex?
Run `npx skills add redis/lettuce --skill writing-javadoc -a codex`. Or copy the skill folder (.agents/skills/writing-javadoc in redis/lettuce) into .agents/skills/writing-javadoc in your project. Codex loads it when a task matches its description.
Can I use Writing Javadoc in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add redis/lettuce --skill writing-javadoc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/writing-javadoc, .gemini/skills/writing-javadoc, .github/skills/writing-javadoc and .opencode/skills/writing-javadoc in your project.
What does Writing Javadoc need to run?
SKILL.md names no scripts, command-line tools or credentials: Writing Javadoc is instructions for the agent only.
Does Writing Javadoc access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Writing Javadoc safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Writing Javadoc use?
Writing Javadoc is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Writing Javadoc use?
About 809 tokens (SKILL.md is roughly 3.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Writing Javadoc?
Skills that share tags, products or a category with Writing Javadoc: Azure Upgrade (microsoft/GitHub-Copilot-for-Azure, 255 stars), Foundatio (FoundatioFx/Foundatio, 2.1k stars), Create Spring Boot Kotlin Project (github/awesome-copilot, 40k stars) and Heroku To AWS (aws/agent-toolkit-for-aws, 2.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Writing Javadoc?
redis (a GitHub organization, an official publisher) maintains it in redis/lettuce, which has 5,780 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on October 11, 2026.
Source: redis/lettuce on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.