Update distribution archive commands in wayang-api-json

Open Beginner friendly
#812 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

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: 
    tar -xvf apache-wayang-assembly-1.1.1-dist.tar.gz
cd wayang-1.1.1
Dominant language
Java
Stars
274
Forks
141
Avg merge
5d 16h
Merged PRs (30d)
4

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.

More from apache/wayang

All issues in apache/wayang

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.