generated from md2docx/md2docx-plugin-template-archived
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
We’d like to improve our developer experience by adding proper API docs and usage guides.
Tasks
-
🔧 Setup Typedoc for API documentation
- Reference: [react18-tools/turborepo-template](https://github.com/react18-tools/turborepo-template)
- Integrate Typedoc into the build / docs workflow
-
✍️ Create developer-friendly documentation:
- Core use-cases
- Common corner cases
- Gotchas & limitations
Why
- Easier onboarding for contributors
- Clearer guidance for integrators using the library
- Helps us avoid repeated Q&A on the same usage pitfalls
Good First Issue?
Yes ✅ — great opportunity to:
- Explore our codebase
- Contribute in a non-intrusive but high-impact way
- Shape how others learn and use the project
If you’re new, start with Typedoc setup — it’s mostly configuration. Once that’s working, expand into documenting corner cases. Small PRs are welcome!
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed