Poor documentation on reference files
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 2.1k
- Forks
- 528
- Avg merge
- 1d 12m
- Merged PRs (30d)
- 54
Description
Description
The documentation on reference files is very poor. For instance, it does not mention the File: ... syntax at all, which is shown for instance in the GitHub dependencies page.
Personal case
In my case, I'm having a lot of trouble trying to make something work, even though I'm not even sure it's possible, because of this lack of documentation:
I'd like to clone a Git repository and use a project in one of its sub-directories. For some reason, the Paket documentation never mentions this use case, which I thought would be more common.
The workaround I used was to clone the whole repo and to reference ../paket-files/.../File.csproj, but it seems like a hack.
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 reference-files documentation and compare it with the GitHub dependencies page, especially the File: ... syntax. Check whether referencing a project in a cloned repository subdirectory is supported, then document the supported syntax and this use case or clarify its limitations. Done means the relevant pages explain the behavior without requiring the reported workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100