Docs: document what directory the parameters to .addFiles...() method family should be relative to
Open
domain: documentation
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 238
- Avg merge
- 2m
- Merged PRs (30d)
- 1
Description
As per title, please document this at https://ts-morph.com/setup/adding-source-files and remove a 100% certain stumbler necessitating source code inspection or trial and error for every new user.
Contributor guide
Research direction
Open https://ts-morph.com/setup/adding-source-files and review the existing documentation for the .addFiles...() method family. Determine which directory the parameters are relative to, then document that relationship on the page; done means a new user no longer needs source inspection or trial and error to understand the paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100