TypeStrong / TypeStrong/typedoc
Group summary pages?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8.5k
- Forks
- 775
- PR merge metrics
- No merged PRs in 30d
Description
Search Terms
group groupDescription category
Problem
I've recently started using @group and @category, which have helped me organise the docs a lot better. I arrange by group in the index so I get the collapsing menus and it's all good.
The main page lists out the contents of each group in order, and I was hoping for the ability to click on group names in the nav column and be taken to a summary page for that group, which would have the @groupDescription tag and then all of the group's members. Does this exist and I have just failed to find it? I see that the group description is being included in the json output.
Suggested Solution
An output config like includeGroupSummaryPages:boolean ?
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 by tracing how @group and @groupDescription are represented in the JSON output and how group names are rendered in the navigation and main page. Done should include a defined configuration behavior for group summary pages, with each page showing its description and all members of that group.
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
- Mostly clear
- Newbie friendliness
- 30/100