AgentSkillsCN

Reference Eagle Docs

参考 Eagle 文档。

SKILL.md

Reference Eagle Documentation

Purpose

This skill provides instructions for AI agents to reference documentation files from memory-bank/details/ when answering questions about Eagle plugin development.

How It Works

For AI Agents: When a user asks about Eagle plugin development topics:

  1. •Read this file (skills/reference-eagle-docs/about.md) to understand the documentation structure
  2. •Identify relevant documentation files in memory-bank/details/ based on the question
  3. •Read and reference those files directly using the read_file tool
  4. •Provide answers based on the documentation content

Documentation Structure

All documentation is located in memory-bank/details/ and organized by category prefix:

API Documentation (api_*.md)

  • •api_eagle_api.md - Core Eagle API methods and classes
  • •api_event_system.md - Event system and listeners
  • •api_ui_apis.md - UI APIs (window, dialog, clipboard, notification)
  • •api_web_api.md - HTTP Web API client
  • •api_web_technology.md - Web technology stack (Chromium, Node.js)
  • •api_nodejs.md - Node.js support and APIs
  • •api_manifest.md - Plugin manifest configuration
  • •api_plugin_types.md - Plugin types (Window, Background, Format, Inspector)
  • •api_tag_group.md - Tag group API
  • •api_item_methods.md - Advanced item methods
  • •api_folder_methods.md - Advanced folder methods
  • •api_tag_methods.md - Advanced tag methods

Tutorials (tutorial_*.md)

  • •tutorial_getting_started.md - Getting started guide
  • •tutorial_data_retrieval.md - How to retrieve data
  • •tutorial_data_modification.md - How to modify data
  • •tutorial_file_access.md - File system operations
  • •tutorial_networking.md - HTTP requests and networking
  • •tutorial_i18n.md - Internationalization
  • •tutorial_frameless_window.md - Frameless window creation
  • •tutorial_distribution.md - Plugin distribution workflow

Implementation Patterns (patterns_*.md)

  • •patterns_item_filtering.md - Item filtering patterns
  • •patterns_subscription_system.md - Subscription/polling patterns
  • •patterns_private_fields.md - Working with private fields
  • •patterns_config_management.md - Configuration management
  • •patterns_bareio.md - Direct file system access (BareIO)
  • •patterns_gitops.md - GitOps workflow patterns

Implementation Details (impl_*.md)

  • •impl_react_setup.md - React setup and architecture
  • •impl_build_config.md - Build configuration (Vite, CJS)

Package Documentation (package_*.md)

  • •package_eagle_cooltils.md - eagle-cooltils utility package

Other

  • •UNEXPLORED_ENDPOINTS.md - API endpoints not yet documented

Usage Instructions for AI Agents

When a user asks about Eagle plugin development:

  1. •

    Identify the topic category:

    • •API questions → api_*.md files
    • •How-to questions → tutorial_*.md files
    • •Best practices → patterns_*.md files
    • •Setup/build → impl_*.md files
    • •Package usage → package_*.md files
  2. •

    Read relevant files:

    • •Use read_file tool to access memory-bank/details/{filename}.md
    • •Read multiple files if the question spans categories
  3. •

    Provide answers:

    • •Reference specific files when citing information
    • •Use code references format: startLine:endLine:memory-bank/details/{filename}.md
    • •Include file paths in responses for user reference

Example Usage Scenarios

User asks: "How do I filter items in Eagle?"

  • •Action: Read memory-bank/details/patterns_item_filtering.md and memory-bank/details/tutorial_data_retrieval.md
  • •Response: Reference the filtering patterns and provide examples

User asks: "What's the Web API?"

  • •Action: Read memory-bank/details/api_web_api.md
  • •Response: Explain the Web API, its methods, and usage

User asks: "How do I set up React in an Eagle plugin?"

  • •Action: Read memory-bank/details/impl_react_setup.md and memory-bank/details/impl_build_config.md
  • •Response: Provide setup instructions with code examples

Quick Reference

Path to documentation: memory-bank/details/

File naming pattern: {category}_{topic}.md

Categories:

  • •api_ - API documentation
  • •tutorial_ - Step-by-step guides
  • •patterns_ - Implementation patterns
  • •impl_ - Implementation details
  • •package_ - Package documentation