ValveSoftware / ValveSoftware/Proton
Dependencies on wiki for packages
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 32.8k
- Forks
- 1.6k
- PR merge metrics
- PR metrics pending
Description
It's a low priority request:
I wish that the wiki could add more information about the package dependency for compilation and for usage (as in when using in steam) since there are two ways to require this project.
The name and reference to the libraries/package to be able to read about them etc, this makes it agnostic to distribution.
On a side note, add general information about how to troubleshoot yourself (guides to read certain logs, certain output by terminal etc) so I basically refer this piece of information everytime I see someone ask for help about Proton.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Proton wiki and determine where package dependencies for compilation and usage should be documented. Define the required library references and troubleshooting guidance, including which logs and terminal output users should inspect; the work is done when both topics are covered in a reusable help page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100