apache / apache/wayang

Update distribution archive commands in wayang-api-json

Open Beginner friendly
#812 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
274
Forks
140
Avg merge
5d 16h
Merged PRs (30d)
4

Description

### Problem Description
1. **Filename Typo**: The documentation file in `wayang-api/wayang-api-json/` is misspelled as `REAME.md` (missing `D`). Because of this typo, GitHub, git web viewers, and documentation generators fail to render the module README overview when browsing `wayang-api/wayang-api-json/`.
2. **Incorrect Archive Name & Directory**: Lines 34–35 specify:
```bash
tar -xvf apache-wayang-assembly-1.1.1-dist.tar.gz
cd wayang-1.1.1

Contributor guide

Open the contributing guide

Research direction

Open the documentation file in wayang-api/wayang-api-json/ and inspect lines 34–35. Rename REAME.md to README.md, update the archive extraction and directory commands as requested, and verify that the module README renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.