docs: remove stale 'oss/' paths from build walkthroughs#364
Merged
Conversation
The repository root is already the OSS workspace, so 'cd oss' fails on a fresh clone and 'pnpm --dir oss' / 'cd oss/packages/cli' reference a layout that no longer exists. Remove the stale step and fix the package commands to run from the clone root. Fixes runxhq#359
There was a problem hiding this comment.
Pull request overview
This PR updates contributor documentation to remove stale oss/-prefixed paths and commands that no longer match the repository layout (the clone root is already the OSS workspace), unblocking “fresh clone” build walkthroughs referenced by issue #359.
Changes:
- Remove
cd osssteps from build/run snippets in key docs. - Update
docs/reference.mdbuild/test/pack commands to run from the repository root and fix thepackages/clipath.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/getting-started.md | Removes the invalid cd oss step before the native cargo build command. |
| docs/reference.md | Updates walkthrough commands to run from the clone root and adjusts the packages/cli path. |
| docs/skill-to-graph.md | Removes the invalid cd oss step from the graph harness walkthrough. |
Comments suppressed due to low confidence (1)
docs/reference.md:670
- The
Boundary Ruleslist still usesoss/andcloud/as if they were directories (even though this repo does not have anoss/folder, andcloud/isn’t present in this checkout). This is now inconsistent with the earlier command fixes and can confuse readers about the workspace layout.
pnpm build
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+670
to
+672
| pnpm build | ||
| pnpm test tests/cli-package.test.ts | ||
| cd packages/cli |
Addresses Copilot review on runxhq#364: note that 'oss/' refers to this repository and 'cloud/' to the private companion workspace (absent from this checkout), so the rule no longer reads as a stale directory path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #359.
The getting-started guide tells new contributors to
cd ossbefore building, but there is nooss/directory in this repository — the checkout root is already the OSS workspace, so the first command fails on a fresh clone. The same stale layout appears in three docs:docs/getting-started.md: drop thecd ossstep beforecargo builddocs/reference.md: drop the samecd ossstep, and fixpnpm --dir oss build/pnpm --dir oss test/cd oss/packages/clito run from the clone root (pnpm build,pnpm test,cd packages/cli)docs/skill-to-graph.md: drop thecd ossstepEach command was verified against a fresh clone: the
oss/paths do not exist, andcrates/Cargo.toml,packages/cli, and the rootpackage.jsonall exist at the locations the fixed commands assume.