[Docs Site] support parsing inherited/imported/extended types
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 140
- Forks
- 100
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 30
Description
Came up in https://github.com/openedx/paragon/pull/4221#discussion_r3501986387
Something like TypeDoc would have a much better "understanding" of the TypeScript types, but be missing most other features we expect on the docs site.
I figure we can work with what we have for now with the current docs site, but we should try to do it better if we're making a new one.
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 current docs site and the discussion in openedx/paragon#4221, especially the linked TypeDoc example. Define how the new docs site should parse inherited, imported, and extended TypeScript types, then verify that the resulting documentation preserves the other expected docs-site features.
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
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100