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

[Copilot]

This PR addresses the documentation standards issue by adding explicit mentions of TSDoc/JSDoc documentation and auto-generated TypeScript declarations throughout the SDK documentation.

Changes Made

Main README.md

• Added a new feature bullet point highlighting that all public APIs include TSDoc/JSDoc comments and auto-generated TypeScript declarations
• Enhanced the API Reference section with a note that all public APIs are documented with TSDoc/JSDoc comments and include auto-generated TypeScript declarations

Package READMEs

Updated the API Reference sections in key packages to mention comprehensive TSDoc/JSDoc documentation:

• @mixcore/api - Added note about API client documentation
• @mixcore/base - Added note about base classes and interfaces documentation
• @mixcore/shared - Added note about utilities and helper functions documentation

Context

The codebase already has extensive TSDoc/JSDoc comments throughout the source code (as seen in files like api-services.ts, base-service.ts, crypto-services.ts, etc.), and the build process successfully generates TypeScript declaration files that include these comments. However, this wasn't clearly communicated to users in the documentation.

Verification

• ✅ All builds pass successfully
• ✅ All tests continue to pass (70+ tests across 9 packages)
• ✅ TypeScript declarations are generated correctly with TSDoc comments included
• ✅ No breaking changes - this is purely a documentation enhancement

These changes make it clear to SDK consumers that:

1. All public APIs are properly documented with TSDoc/JSDoc
2. Type definitions are automatically generated and available
3. The SDK follows documentation best practices for TypeScript libraries

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

• mixcore.net
  • Triggering command: node /home/REDACTED/work/javascript-sdk/javascript-sdk/node_modules/.bin/../jest/bin/jest.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.