README leads to confusion
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 563
- Forks
- 108
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 3
Description
The README states:
This repository contains the source code of the Solid specification, which aims to be a clear, unambiguous, and implementable rewrite of the Unofficial Draft.
And directly below:
For the time being, while the migration is in progress, please refer to the existing draft documents if you want to implement a pod server or a solid app.
Which documents are meant with "the existing draft documents"? Are these the ones in the other "Unofficial Draft" repository?
Contributor guide
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 by reading the README wording quoted in this issue and checking which documents are meant by “the existing draft documents,” including the other “Unofficial Draft” repository mentioned. Done means the README clearly identifies the referenced documents or repository so readers know where to look.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100