New API swagger workflow docs + Documenting APIs guide #38
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
armando-salazar
added
the
documentation
sfgarza
reviewed
May 16, 2025
| - Example: `packages/common/src/schemas/cluster/build-status.schema.ts` | ||
| - Contains path definitions, method lists, and data schemas | ||
|
|
||
| 2. **Documentation files** (`packages/server-core/src/[category]/[name]/[name].docs.ts`): |
There was a problem hiding this comment.
Can we stress the importance of this step more? Although feathers/swagger automates most of the documentation, without developer descriptions, examples and parameter descriptions the documentation generated is not the most useful since descriptions default to a very generic message such as Creates a new resource with data.
…n proper descriptions
Author
|
Enhanced API documentation guides with workflow details and improved emphasis on proper descriptions. Added information about hooks, validators, and resolvers based on developer feedback. Also included details about API organization and the standard development workflow. |
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.
This PR adds comprehensive guides for the API documentation system to the manual. The guides explain how to document APIs in the iR Engine codebase.
Changes
Added a new section under modules called "API Documentation System"
Created two main guides:
Updated navigation and cross-references throughout the documentation
Organized content to clearly reflect its focus on documenting APIs
Testing