-
Notifications
You must be signed in to change notification settings - Fork 14
1017554- Added UG documentation for document SDK skills #2480
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
Open
sathiyaseelanksf3503
wants to merge
5
commits into
DocumentSDK_Skill
Choose a base branch
from
ES-1017554-SkillPdfViewer
base: DocumentSDK_Skill
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0398544
1017554: Updated the skills on pdf viewer
sathiyaseelanksf3503 9ef312c
1017554: Resolved the CI issues
sathiyaseelanksf3503 db2b5e7
Merge branch 'DocumentSDK_Skill' into ES-1017554-SkillPdfViewer
sathiyaseelanksf3503 5994754
1017554: Resolved the CI issues
sathiyaseelanksf3503 0d0c680
1017554: Resolved the CI issues
sathiyaseelanksf3503 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: Syncfusion PDF Viewer SDK Agent Skills for AI Assistants | Syncfusion | ||
| description: Learn how to install and use Syncfusion PDF Viewer SDK Agent Skills to help AI assistants generate accurate PDF Viewer code using PDF Viewer SDK libraries | ||
| platform: document-processing | ||
| control: PDF Viewer SDK | ||
| documentation: ug | ||
| keywords: Skills, AI Assistants, PdfViewer SDK, Agent Skills | ||
| --- | ||
|
|
||
| # Syncfusion PDF Viewer SDK Agent Skills for AI Assistants | ||
|
|
||
| This guide introduces **Syncfusion PDF Viewer SDK Skills**, a curated skill package that enables AI assistants (GitHub Copilot, Code Studio, Cursor, Claude, etc.) to generate accurate, production ready PDF Viewer integration code using the Syncfusion<sup style="font-size:70%">®</sup> PDF Viewer components across supported platforms. | ||
|
|
||
| Unlike generic AI suggestions, these skills ground the assistant in official Syncfusion<sup style="font-size:70%">®</sup> PDF Viewer APIs, configuration patterns, and platform specific setup details—ensuring correct usage, faster Onboarding, and fewer integration issues. | ||
|
|
||
| ## Supported Platforms | ||
|
|
||
| Syncfusion<sup style="font-size:70%">®</sup> PDF Viewer SDK Agent Skills provide guidance for the following platforms: | ||
|
|
||
| | PDF Viewer Libraries | Skills | | ||
| |---|---| | ||
| | [Blazor](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/blazor/overview) | [syncfusion-blazor-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/main/skills/syncfusion-blazor-pdf-viewer) | | ||
| | [React](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/react/getting-started-overview) | [syncfusion-react-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/main/skills/syncfusion-react-pdf-viewer) | | ||
| | [Flutter](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/flutter/overview) | [syncfusion-flutter-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/main/skills/syncfusion-flutter-pdf-viewer) | | ||
| | [.NET MAUI](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/maui/overview) | [syncfusion-maui-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/main/skills/syncfusion-maui-pdf-viewer) | | ||
| | [WinForms](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/winforms/overview) | [syncfusion-winforms-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/main/skills/syncfusion-winforms-pdf-viewer) | | ||
| | [WPF](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/wpf/overview) | [syncfusion-wpf-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/main/skills/syncfusion-wpf-pdf-viewer) | | ||
|
|
||
| Each platform’s skill file includes component initialization, property configuration, event handling, and common usage patterns specific to that framework. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before installing Syncfusion<sup style="font-size:70%">®</sup> PDF Viewer SDK Skills, ensure the following: | ||
|
|
||
| - **[Node.js]("https://nodejs.org/")** (v18 or later) — Required to run `npx` commands for installing skills. | ||
|
|
||
| ## Installation | ||
|
|
||
| Choose one of the following commands to install the Syncfusion PDF Viewer SDK Agent Skills. | ||
|
|
||
| ```bash | ||
| npx skills add syncfusion/pdf-viewer-sdk-skills --all -y | ||
| ``` | ||
|
|
||
| To install a specific skill, use the following command (for example, to install PDF .Net skills): | ||
|
|
||
| ```bash | ||
| npx skills add syncfusion/pdf-viewer-sdk-skills | ||
| ``` | ||
|
|
||
| ## What's Included | ||
|
|
||
| 1. **PDF Viewer API Knowledge** - Curated, platform-specific guidance for working with Syncfusion<sup style="font-size:70%">®</sup> PDF Viewer components, including: | ||
| - Loading PDF documents from local files, URLs, and byte streams | ||
| - Configuring toolbar items and viewer options | ||
| - Zooming, scrolling, and navigation | ||
| - Text selection and search | ||
| - Annotations (shape, text markup, stamps, etc.) | ||
| - Form field interaction | ||
| - Event handling (document load, page change, annotation events) | ||
| 2. **Platform-Specific Code Generation** — Generates production-ready code tailored to your platform without executing scripts or modifying your project structure. No files are generated on disk. | ||
| 3. **Best Practices & Configuration Patterns** - The skills enforce Syncfusion<sup style="font-size:70%">®</sup> recommended practices, including: | ||
| - Correct package / NuGet / npm selection per platform | ||
| - Proper component initialization and life cycle usage | ||
| - Platform-appropriate configuration for performance and UX | ||
| - Syncfusion license setup using: | ||
| - `SyncfusionLicense.txt`, or | ||
| - `SYNCFUSION_LICENSE_KEY` environment variable | ||
| Only APIs and patterns explicitly defined in the skill reference files are used. | ||
|
|
||
| ## How Syncfusion<sup style="font-size:70%">®</sup> PDF Viewer SDK Agent Skills Work | ||
|
|
||
| 1. **Reads the relevant platform-specific skill files** - Based on the user’s query (for example, React vs WPF), the assistant loads the appropriate PDF Viewer skill reference. | ||
|
|
||
| 2. **Generates accurate, platform-specific code** - The assistant: | ||
| - Uses the correct component names and APIs | ||
| - Applies valid configuration options | ||
|
|
||
| ## Using the AI Assistant with PDF Viewer Skills | ||
|
|
||
| Once installed, the assistant can help generate PDF Viewer integration code. Below are example prompts. | ||
|
|
||
| ## Example Prompts | ||
|
|
||
| - “Show me how to load a PDF file in Syncfusion PDF Viewer for React.” | ||
| - “Give an example of enabling text search in Blazor PDF Viewer.” | ||
| - “How do I add annotation support in WPF Syncfusion PDF Viewer?” | ||
| - “Provide sample code to customize the toolbar in MAUI PDF Viewer.” | ||
| - “Show how to load a PDF from a URL in Flutter PDF Viewer.” | ||
| - “How to navigate to a specific page in Winforms PdfViewer?” | ||
|
|
||
| ## Documentation Reference | ||
|
|
||
| For detailed API documentation and feature explanations, refer to the official Syncfusion PDF Viewer documentation: | ||
|
|
||
| - **[React PDF Viewer Overview](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/react/overview)** | ||
|
|
||
| (Equivalent documentation is available for Blazor, Flutter, MAUI, WinForms, and WPF.) | ||
|
|
||
| ## See Also | ||
|
|
||
| - [Syncfusion PDF Viewer Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview) | ||
| - [Skills CLI Documentation](https://skills.sh/docs) | ||
| - [Agent Skills Standards](https://agentskills.io/home) | ||
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.