(Curious) Editor integration focus in 2023?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I like the idea of TSDoc and prefer to use the “official” syntax (with the help of linters). However, I often find myself tweaking some doc content to adhere to editor rendering (I use WebStorm (JetBrains/IntelliJ) primarily, but colleagues use VS Code).
So, what focus on editor integration exists in 2023?
For example, should we open issues to “fix” rendering issues. (I just came across issues with @link (finalized I think?) and @see (not finalized), which prompted me to ask this question.)
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 reviewing the reported editor-integration concerns for WebStorm and VS Code, especially rendering of @link and @see. Determine whether these rendering issues belong in separate issues and what editor-integration focus is appropriate for TSDoc. Done means reaching and documenting a clear direction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100