Skip to content

Add documentation about TSDoc/JSDoc comments and auto-generated API docs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Modular, framework-agnostic SDK for Mixcore projects. Built with TypeScript and
- **Production-ready**: Well-tested and documented
- **Secure by design**: Configuration injection prevents hardcoded secrets
- **Extensible**: Plugin/adapter architecture for custom implementations
- **Fully typed**: All public APIs include TSDoc/JSDoc comments and auto-generated TypeScript declarations

## Packages

Expand Down Expand Up @@ -63,6 +64,8 @@ const data = await sdk.database.fetchDataItems('module-id');

## API Reference

All public APIs are documented with TSDoc/JSDoc comments and include auto-generated TypeScript declarations. Type definitions are available for all methods, interfaces, and configuration options.

### Core SDK Methods

| Method | Parameters | Returns | Description |
Expand Down
2 changes: 2 additions & 0 deletions packages/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ const sdk = createMixcoreSdk(

## API Reference

All public APIs include comprehensive TSDoc/JSDoc documentation and auto-generated TypeScript declarations.

### ApiService Methods

| Method | Parameters | Returns | Description |
Expand Down
2 changes: 2 additions & 0 deletions packages/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ class MyService extends BaseService {

## API Reference

All base classes and interfaces include comprehensive TSDoc/JSDoc documentation and auto-generated TypeScript declarations.

### BaseService Methods

| Method | Parameters | Returns | Description |
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ console.log(DEFAULT_CONFIG.apiBaseUrl);

## API Reference

All utilities and helper functions include comprehensive TSDoc/JSDoc documentation and auto-generated TypeScript declarations.

### Utility Functions

| Function | Description |
Expand Down
6 changes: 6 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.