typescript-eslint / typescript-eslint/ts-api-utils
📝 Documentation: Find a theme for the website
Open
Nobody has claimed this yet.
area: documentation
status: needs investigation
type: feature
- Dominant language
- TypeScript
- Stars
- 122
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Bug Report Checklist
- I have pulled the latest
mainbranch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
Following up on #70: we're using the stock TypeDoc theme right now. It works fine but looks rather... plain.
Let's find a theme that looks nicer, yeah?
Additional Info
I haven't put much thought or design investigation work into this. If there's a nice theme you as a contributor know of (such as from https://typedoc.org/guides/themes), feel free to post it here to solicit feedback.
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 reviewing the TypeDoc themes guide linked in the issue and the related discussion in #70. Done means proposing a nicer TypeDoc theme for the generated website and gathering contributor feedback on the choice.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100