openstreetmap / openstreetmap/iD
Create some searchable documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.9k
- Forks
- 1.5k
- Avg merge
- 5d 3h
- Merged PRs (30d)
- 44
Description
URL
How to reproduce the issue?
Currently, what documentation there is for iD is only available as unselectable and unsearchable text in inside the iD window after clicking "?" at the bottom right of the help window.
In addition, a lot of information seems to be missing altogether - see https://community.openstreetmap.org/t/id-visibility-of-relations/138374 for some of the things that are missing (see comments like "It isn’t terribly discoverable").
Screenshot(s) or anything else?
No response
Which deployed environments do you see the issue in?
No response
What version numbers does this issue effect?
No response
Which browsers are you seeing this problem on?
No response
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 with the iD help window opened by clicking "?" at the bottom right, and review the current unselectable text alongside the linked community discussions. Clarify which missing topics and documentation location are in scope; done means the relevant iD documentation is searchable and covers the agreed missing information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100