skills.rest
noise-xyz
noise-xyzOFFICIAL
Explore all skills by this author →
Website𝕏@noise_xyzGitHub

brane-docs

Update Javadoc and website docs after public API changes in Java SDK modules.

9|1|Updated Nov 19, 2025
Search Tags:#documentation#consistency#API#website#update#Javadoc
One-click install
npx skills add https://github.com/noise-xyz/brane --skill brane-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: brane-docs
Source: https://github.com/noise-xyz/brane/tree/main/.claude/skills/brane-docs
Command: npx skills add https://github.com/noise-xyz/brane --skill brane-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures documentation stays accurate after implementing features by updating Javadoc and website docs.

Core Features & Use Cases

  • Update Javadoc for new public API elements in core modules
  • Synchronize website docs to reflect current public API
  • Use case: after implementing a new public type or method, ensure both internal and external docs match

Quick Start

Identify public API changes with git diff, update Javadoc comments in source files for the affected API, and refresh website documentation to reflect the changes.

Frequently Asked Questions about brane-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update Javadoc comments after changing public APIs?▼

To update Javadoc after public API changes, identify modified elements using git diff, then update the Javadoc comments directly in affected source files to accurately reflect the new public types or methods.

When do I need to synchronize website documentation with code changes?▼

You need to synchronize website documentation with code changes immediately after implementing features that affect public APIs, ensuring both internal Javadoc and external website references remain consistent.

Can I use this to align CLAUDE.md references with Java SDK module updates?▼

Yes, you can use this to align CLAUDE.md references with Java SDK module updates, specifically synchronizing documentation across modules like brane-core, brane-rpc, and brane-contract after public API modifications.

What is the best way to keep documentation consistent across multiple Java SDK modules?▼

The best way to keep documentation consistent is to update Javadoc comments in source files and align website documentation simultaneously after implementing features, ensuring all public API references match across the modules.

Does updating public API documentation require checking specific Java modules?▼

Yes, updating public API documentation requires checking specific Java SDK modules including brane-core, brane-rpc, brane-contract, brane-primitives, and brane-kzg to ensure comprehensive documentation consistency.

Related Skills

Explore More Content & Communication Skills→
anishi1222anishi1222

java-docs

Scan Java source files for missing or inadequate Javadoc comments.

Community
Basic
JetBrainsJetBrains
302

skillshare-update-docs

Synchronize website documentation with recent Go source code changes.

Official
Advanced
roach88roach88
2

add-docs

Generate standards-compliant documentation for source code files across multiple programming languages.

Community
Intermediate
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate