line / line/centraldogma

Update documentation for child `Watcher`s

Open
#446 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Java
Stars
668
Forks
135
Avg merge
4d 19h
Merged PRs (30d)
7

Description

0.42.0 introduced child `Watcher`s on the client side, but we did not add documentation for it yet, although we have some explanation in the release note. /cc @mauhiz

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the release note's explanation of child Watchers and review the existing client-side documentation to find the appropriate section. Document the child Watcher behavior introduced in version 0.42.0, with enough explanation for users to understand and use it; the issue is done when that documentation is added and consistent with the release note.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.