Skip to content

Rename REAME.md to README.md and fix binary assembly paths in wayang-api-json - #815

Open
AliRana30 wants to merge 1 commit into
apache:mainfrom
AliRana30:fix-api-json-readme
Open

AliRana30 wants to merge 1 commit into
apache:mainfrom
AliRana30:fix-api-json-readme

Conversation

@AliRana30

Copy link
Copy Markdown
Contributor

Description

This PR fixes two documentation issues in wayang-api/wayang-api-json:

Closes : #812

  1. Filename Typo: Renamed wayang-api/wayang-api-json/REAME.md to README.md (git mv). Due to the missing D, GitHub, package mirrors, and documentation tools failed to render the module README overview when viewing the wayang-api-json directory.
  2. Outdated Binary Archive Extraction Instructions: In lines 34–35, updated the extraction instructions to match the current Wayang build output:
    • Changed tar -xvf apache-wayang-assembly-1.1.1-dist.tar.gz to tar -xvf wayang-assembly-1.1.2-SNAPSHOT-dist.tar.gz.
    • Changed cd wayang-1.1.1 to cd wayang-1.1.2-SNAPSHOT.

Type of Change

  • Documentation update (fixes broken filename and outdated setup instructions)

Verification

  • Verified file rename in git tree (REAME.md -> README.md).
  • Verified assembly target naming matches <finalName>wayang-assembly-${project.version}</finalName> in wayang-assembly/pom.xml.

Copilot AI lite review requested due to automatic review settings September 13, 2026 18:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update distribution archive commands in wayang-api-json

2 participants