donmccurdy / donmccurdy/glTF-Transform

improve dedup doc : default params

Open
#1,145 1 comment 0 reactions 0 assignees View on GitHub
documentation feature
Dominant language
TypeScript
Stars
2k
Forks
206
Avg merge
2d 2h
Merged PRs (30d)
16

Description

**Is your feature request related to a problem? Please describe.**
Improve the documentation of dedup function to specify the property dedup by default :

```
PropertyType.ACCESSOR,
PropertyType.MESH,
PropertyType.TEXTURE,
PropertyType.MATERIAL,
PropertyType.SKIN,
```

**Describe alternatives you've considered**
Alternative : also add it to DedupOptions

**Additional context**
While reading the documentation page of dedup, I wasnt sure and went to the source code to double check, I think it can be easily avoid for futur users.

Contributor guide

Open the contributing guide

Research direction

Start at the dedup documentation page and compare its documented defaults with the source implementation. Review the DedupOptions reference mentioned in the issue before deciding where the information belongs. The work is done when the documentation clearly lists the default properties dedup processes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.