bytedance / bytedance/CompoundVM

[Docs] Fix unusable commands and placeholder links in the usage Wiki

Open
#175 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
118
Forks
22
Avg merge
8d 8h
Merged PRs (30d)
4

Description

## Affected live documentation

https://github.com/bytedance/CompoundVM/wiki/How-to-Use-CompoundVM at wiki revision `25eb83234c86ed76f91d52c8e560795809b27be6` (2025-12-26).

## Problem

The current Wiki guide contains several instructions or links that cannot be used as written.

### 1. The post-build verification path names a non-existent version

Lines 71-72 use:

```bash
output/CompoundVM_8.1.0_linux_x64//bin/java -version
output/CompoundVM_8.1.0_linux_x64//bin/java -server17 -version
```

There is no CompoundVM 8.1.0 release, the path contains a doubled slash, and the build output name is derived from the current `cvm/conf/version` value rather than a fixed 8.1.0 directory.

### 2. The documented environment variable is not consumed by the Java launcher

Line 167 recommends:

```bash
JAVA_OPTIONS=-server17
```

Neither the repository launcher code nor the standard Java launcher recognizes `JAVA_OPTIONS` as a VM-options environment variable. In addition, `-server17` is a VM-selection launcher option, so substituting a standard VM-options variable may not be equivalent; the supported way to select JVM 17 implicitly should be confirmed and documented by maintainers.

### 3. Two links are literal placeholders

- line 129: `[Configuration Guide](link-to-configuration-guide)`
- line 194: `[Discussion Forum](link-to-discussion-forum)`

Both resolve relative to the Wiki and return missing pages.

## Impact

Users following the official live guide can end up invoking a path that was never generated, configuring an environment variable with no effect, or navigating to missing documentation.

## Expected result

- derive the verification path from the current documented release/build output, or show a version-neutral shell variable;
- document a tested, supported way to select the JVM 17 mode by default;
- replace or remove both placeholder links;
- keep the install examples aligned with the current release index.

## Why there is no PR with this report

These pages live in the separate GitHub Wiki repository, which has no fork-to-upstream pull-request workflow. The environment-variable correction also needs confirmation of the intended launcher behavior. This is therefore an issue-only documentation report for maintainers to apply to the Wiki or migrate into a reviewable repository documentation source.

I checked the complete issue/PR inventory and found no existing report covering these Wiki instructions.

Contributor guide

Open the contributing guide

Research direction

Start with the live How-to-Use-CompoundVM Wiki page at revision 25eb83234c86ed76f91d52c8e560795809b27be6, then inspect cvm/conf/version and the repository launcher code. Verify the generated output path and the supported JVM 17 environment-variable behavior before editing the examples. Done means the commands work with the current release index, the JVM 17 instructions are tested, and both placeholder links are replaced or removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.