android / android/skills

[Bug] android-cli: malformed JSON example in journeys.md

Open Beginner friendly
#140 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
7.3k
Forks
476
Avg merge
8h 59m
Merged PRs (30d)
7

Description

### Affected Skill
`devtools/android-cli`

### Description
The "Summarizing" section of `references/journeys.md` shows example output that isn't valid JSON:
- Fenced as a plain code block (not ` ```json `)
- Contains inline `//` comments (not valid JSON)
- Has a malformed key (`"journey:",`)
- Has an unterminated string (`"action": "Click the blue button,`)
- Has trailing commas after the last property in each object

### Expected Behavior
The example should be valid, parseable JSON, since the instruction given is "output JSON describing the results."

### Actual Behavior
The example block cannot be parsed as JSON. This risks an agent copying the same malformed structure (comments, trailing commas, unterminated strings) into its actual output when following this section.

### Steps to Reproduce
1. Open `references/journeys.md` → "Summarizing" section.
2. Try to parse the example block as JSON → fails (unterminated string, trailing commas, `//` comments, malformed `"journey:",` key).

### Suggested Fix
Fence the example as ` ```json ` with valid syntax (closed strings, no trailing commas, no inline comments), and move the field explanations (meaning of `status`, `commands`, `comment`, valid `status` values) into a separate "Field reference" list below the example.

Contributor guide

Open the contributing guide

Research direction

Open references/journeys.md and locate the "Summarizing" section. Replace the malformed example with fenced, parseable JSON using closed strings and no comments or trailing commas, then move the field explanations into a separate "Field reference" list. Done means the example can be parsed as JSON and documents the requested fields and status values.

Written by the indexing model from the issue text.

Assessment

Tech stack
android
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.