Client and server guides seems to be outdated
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 1.4k
- Forks
- 100
- Avg merge
- 18h 7m
- Merged PRs (30d)
- 2
Description
Hi,
It seems that the implementation guides (https://jmap.io/server.html & https://jmap.io/client.html) are outdated.
For example they use ModSeq rather than state and fetchRecordProperties rather than properties.
It's confusing, Is there plan to update them?
If I'm wrong, feel free to close the issue.
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 by comparing the implementation guides at jmap.io/server.html and jmap.io/client.html with the current terminology cited in the issue, including state and properties. Update outdated examples and wording in both guides, with completion meaning the guides no longer use the obsolete terms such as ModSeq and fetchRecordProperties.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100