-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Smilefounder <3785721+Smilefounder@users.noreply.github.com>
Co-authored-by: Smilefounder <3785721+Smilefounder@users.noreply.github.com>
Copilot
AI
changed the title
(削除) [WIP] Documentation Standards
No TSDoc/JSDoc references or mention of auto-generated API docs.
Recommendation: Add a note that all public APIs are documented and types are available. (削除ここまで)
(追記) Add documentation about TSDoc/JSDoc comments and auto-generated API docs (追記ここまで)
Jul 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
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
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 documentationContext
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
These changes make it clear to SDK consumers that:
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.netnode /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:
💡 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.