Skip to content

docs: fix stale vx-core example and align zh contributing tree comments - #1217

Merged
loonghao merged 1 commit into
mainfrom
task/p4-vx-scripts-test-sh-59-vx-core-zh-contributing-644c45a0130f
Oct 18, 2026
Merged

loonghao merged 1 commit into
mainfrom
task/p4-vx-scripts-test-sh-59-vx-core-zh-contributing-644c45a0130f

Conversation

@loonghao

Copy link
Copy Markdown
Collaborator

Summary

Two text-only cleanups in the vx repo, with no behavior change.

  • scripts/test.sh: the usage example referenced -p vx-core, a package that no
    longer exists after it was merged into vx-runtime-core. The example would send
    users to a nonexistent target, so it now points at the real crate name.
  • docs/zh/advanced/contributing.md: the crate rows of the directory tree had their
    # comment column shifted one column off from the book/, tests/ and
    examples/ rows in the same block. The crate rows are pulled back so every comment
    in the block starts at the same column.

Validation

  • bash scripts/check-architecture.sh output is byte-identical before and after.
  • bash scripts/test.sh --help output is unchanged except for the single example
    line being corrected; no script behavior is touched.
  • The directory tree block now has all comment markers at the same display column;
    content outside the block is untouched.

Scope

Only these two files are modified. No crate is renamed and no Rust source,
Cargo.toml, Cargo.lock, version field or release manifest is changed. This is
docs/scripts-only, so change-aware skipping of Rust jobs in CI is expected.

The usage example in scripts/test.sh pointed at the vx-core package, which
no longer exists on disk after it was merged into vx-runtime-core, so the
example would send users to a nonexistent target. Update it to the real
crate name.

Also realign the crate rows of the directory tree in the Chinese
contributing guide so every comment in the block starts at the same
column as the book/, tests/ and examples/ rows.

Text-only; no behavior change.
@loonghao
loonghao merged commit a95008f into main Oct 18, 2026
46 checks passed
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.

1 participant