docs: align setup guide with current repository - #12
Closed
Neonstudio28 wants to merge 1 commit into
Closed
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
CONTRIBUTING.md contains a couple of remaining accuracy issues (CI job coverage wording and a misleading repository tree entry) that should be corrected to fully match the current checkout/workflow.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates contributor-facing documentation to reflect the repository’s current state (canonical URL, available CI checks, and actual directory layout), removing references to scripts and components that aren’t in this checkout.
Changes:
- Update clone/upstream URLs to the canonical
knewnothing-git/gpusion-driver.git. - Document the CMake/Ninja Linux syntax-check build path and clarify it does not produce a loadable Windows driver.
- Replace outdated repository layout and testing instructions with the current tree/CI workflow descriptions.
File summaries
| File | Description |
|---|---|
| README.md | Updates setup guidance to the current repo URL and documents the Linux CMake/Ninja syntax-check path and current checkout layout. |
| CONTRIBUTING.md | Updates fork/branch workflow, repository structure, and testing/CI guidance to remove references to missing PowerShell scripts and directories. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+155
to
+159
| │ ├── vram/ # Virtual VRAM management | ||
| │ └── wddm/ # WDDM display miniport driver | ||
| ├── docs/ # Technical documentation | ||
| └── scripts/ # Build and install scripts | ||
| ├── CMakeLists.txt # Linux syntax-check configuration | ||
| └── driver/gpusion.inf # Driver installation manifest |
| ### Linux CI checks | ||
|
|
||
| ### Integration Tests | ||
| The current CI workflow runs the CMake/GCC syntax check and cppcheck on every pull request. Run the syntax check locally with: |
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.
Summary
The README and CONTRIBUTING guide pointed contributors to repository URLs, build scripts, test runners, and directories that are not present in the current checkout. This docs-only change:
Closes #11
Validation
git diff --checkpasses.Please confirm whether this focused change is eligible for the documented Documentation improvement bounty (₹500). If accepted, payout details can be supplied privately by UPI or bank transfer.