Turfjs / Turfjs/turf

Add DE-9IM graphics to Web Documentation

Open
#1,140 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
TypeScript
Stars
10.5k
Forks
1k
Avg merge
1h 11m
Merged PRs (30d)
4

Description

Add DE-9IM graphics to Web Documentation

I was attempting to explain what @turf/boolean-disjoint was to someone and even I got confused on what that module was meant to do, I then decided to go to ESRI's docs and look at the disjoint graphic for more help.

We should try to include at least 1 info graphic to each module (optional) which helps better understand what the module does in a conceptual way.

http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm

These infographics are very useful

equal

image

disjoint

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the web documentation entry for @turf/boolean-disjoint and the linked ESRI spatial-relations reference. Clarify which modules are in scope and what graphics are required; done means the agreed DE-9IM graphics are present in the web documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.