apple / apple/servicetalk

Enhance docs to embed code

Open
#492 4 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Java
Stars
1k
Forks
229
Avg merge
23h 23m
Merged PRs (30d)
16

Description

Some docs include code snippets from examples. For example the HTTP README.adoc. We should investigate tooling to extract code from examples to avoid duplication and stale docs.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing HTTP README.adoc and the example code snippets it duplicates. Investigate how the examples could provide source content for the documentation, and define what tooling or workflow would prevent the snippets from becoming stale. Done means a concrete approach is documented or implemented and its synchronization behavior is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.