Documentation of @nestia/agent
#1208
Merged
Conversation
This file contains 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
samchon
added
documentation
# for free
to join this conversation on GitHub.
Already have an account?
# 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 pull request includes several documentation enhancements and minor version updates for the
NestiaAgentpackage. The changes primarily focus on improving the clarity and comprehensiveness of the documentation for various interfaces and types used in theNestiaAgentpackage.Documentation Enhancements:
packages/agent/src/NestiaAgent.ts: Expanded the class-level documentation forNestiaAgentto include detailed descriptions of its constructors and accessors.packages/agent/src/structures/INestiaAgentConfig.ts: Added detailed descriptions for theINestiaAgentConfiginterface, explaining its properties and their effects on the agent's behavior.packages/agent/src/structures/INestiaAgentController.ts: Provided comprehensive documentation for theINestiaAgentControllertype, including descriptions for its subtypes and their properties.packages/agent/src/structures/INestiaAgentProps.ts: Added detailed documentation for theINestiaAgentPropsinterface, outlining the properties required to instantiate aNestiaAgent.packages/agent/src/structures/INestiaAgentSystemPrompt.ts: Documented theINestiaAgentSystemPromptinterface, explaining the various system prompts and their customization options.Version Update:
packages/agent/package.json: Updated the version from0.3.9to0.3.10.These changes aim to improve the usability and understanding of the
NestiaAgentpackage for developers by providing more detailed and structured documentation.