Skip to content

feat: update skills according to latest docs - #15

Merged
zhqjiang merged 2 commits into
mainfrom
feat/update-skills-and-templates
Mar 26, 2026
Merged

feat: update skills according to latest docs#15
zhqjiang merged 2 commits into
mainfrom
feat/update-skills-and-templates

Conversation

@zhqjiang

Copy link
Copy Markdown
Contributor

…rty types

  • Introduced new markdown files for I18nText, overview and core concepts, property base fields, property type overview, property UI reference, resource locator, resource mapper, and special type properties.
  • Updated the main declarative parameters reference to link to the new focused pages for easier navigation.
  • Enhanced the model plugin development guide with clearer descriptions and updated examples.
  • Improved the publishing guide with additional checks for plugin definition consistency.
  • Revised the quick start guide for better clarity and added steps for project structure and debugging.
  • Updated tool plugin development guide to include context handling and file management.
  • Made various dependency updates in package.json and adjusted TypeScript configurations for better development experience.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures and expands Atomemo plugin-development documentation by splitting the declarative-parameters reference into focused pages, updating multiple guides to reflect current SDK patterns (notably context and file handling), and refreshing the TypeScript template’s dev/build configuration for conditional “development” exports.

Changes:

  • Split declarative-parameters.md into multiple dedicated reference pages and updated cross-links.
  • Updated tool/model/credential/publishing/quick-start docs with clearer workflows and newer SDK/runtime concepts (e.g., context.files).
  • Updated the TypeScript template to use a development export condition (tsdown + tsconfig) and refreshed dependency versions.

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/templates/typescript/tsdown.config.ts.etaEnables conditional dev exports using the development condition.
src/templates/typescript/tsconfig.json.etaAdds customConditions: ["development"] to align TS resolution with conditional exports.
src/templates/typescript/package.json.etaAdds conditional exports mapping for development vs default; updates release script and dependency versions.
src/templates/common/.agents/skills/atomemo-plugin-development/references/tool-plugin.mdUpdates tool guide to include { args, context } and adds context.files guidance.
src/templates/common/.agents/skills/atomemo-plugin-development/references/quick-start.mdReworks quick start into a clearer step-based workflow and adds project structure + debugging steps.
src/templates/common/.agents/skills/atomemo-plugin-development/references/publishing.mdAdds pre-submit checks (including plugin definition consistency) and clarifies release flow.
src/templates/common/.agents/skills/atomemo-plugin-development/references/model-plugin.mdClarifies model plugin purpose and refreshes examples/parameter notes.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters.mdConverts monolithic reference into an index linking to focused pages.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-special-type-properties.mdNew focused page for credential/encrypted/file-ref property types.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-resource-mapper.mdNew focused page documenting resource_mapper and its callback/value types.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-resource-locator.mdNew focused page documenting resource_locator modes, callback, and runtime value.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-property-ui-reference.mdNew focused UI component reference page.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-property-type-overview.mdNew overview table for property types and plugin-type support notes.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-property-base.mdNew focused page for PropertyBase fields.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-overview-and-core-concepts.mdNew conceptual overview of the declarative parameter system.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-i18n-text.mdNew focused I18nText page and rules.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-examples.mdAdds examples for file_ref, resource_locator, resource_mapper and updates intro/outro.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-display-condition.mdNew focused DisplayCondition reference.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-default-ui-behavior.mdNew focused doc for UI defaults.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-composite-type-properties.mdNew focused doc for object/array/discriminated union property details.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-basic-type-properties.mdNew focused doc for string/number/boolean property details.
src/templates/common/.agents/skills/atomemo-plugin-development/references/declarative-parameters-advanced-patterns-best-practices.mdNew focused doc for advanced patterns (shared params, expressions, etc.).
src/templates/common/.agents/skills/atomemo-plugin-development/references/credential.mdUpdates credential docs and examples (incl. new authenticate signature and OAuth2 notes).
src/templates/common/.agents/skills/atomemo-plugin-development/references/core-concepts.mdNew core concepts page (architecture, lifecycle, file handling).
src/templates/common/.agents/skills/atomemo-plugin-development/SKILL.mdUpdates the skill’s guidance, reading order, and references to new docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…plugin development
- Introduced new markdown files for DisplayCondition, I18nText, PropertyBase, Property Type Overview, Resource Locator, Resource Mapper, and Special Type Properties.
- Updated existing documentation to reflect new features and improvements in the Atomemo plugin system.
- Enhanced the Quick Start guide for better clarity on project setup and development workflow.
- Improved the Model and Tool Plugin Development Guides with clearer descriptions and examples.
- Added detailed sections on file handling and advanced parameter types in tool plugins.
@zhqjiang
zhqjiangforce-pushed the feat/update-skills-and-templates branch from d226682 to de6d280CompareMarch 26, 2026 03:56
@zhqjiangzhqjiang changed the title feat: Add detailed documentation for declarative parameters and prope…feat: update skills according to latest docsMar 26, 2026
@zhqjiang
zhqjiang merged commit e72e8be into mainMar 26, 2026
0 of 6 checks passed
@zhqjiang
zhqjiang deleted the feat/update-skills-and-templates branch March 26, 2026 04:10
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@zhqjiang