Skip to content

Task(1043185): Revamped the UG documentation for the Annotation, Annotation Types, and Export/Import samples on the Angular platform.#3842

Open
Dhanush-git26 wants to merge 13 commits into
developmentfrom
EJ2-1043185-RevampAngular2
Open

Task(1043185): Revamped the UG documentation for the Annotation, Annotation Types, and Export/Import samples on the Angular platform.#3842
Dhanush-git26 wants to merge 13 commits into
developmentfrom
EJ2-1043185-RevampAngular2

Conversation

@Dhanush-git26

@Dhanush-git26 Dhanush-git26 commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

1043185: Revamped the UG documentation for the Annotation, Annotation Types, and Export/Import samples in the Angular platform.
Task Link: https://dev.azure.com/EssentialStudio/Ej2-Web/_workitems/edit/1043185/

Files to be covered: 47
Annotation Samples:

  1. annotation-comment-filter
  2. annotation-event
  3. annotation-permission
  4. annotations-api
  5. annotations-in-mobile-view
  6. annotations-undo-redo
  7. comments
  8. create-modify-annotation
  9. custom-data
  10. customize-annotation
  11. custom-tools
  12. delete-annotation
  13. flatten-annotation
  14. free-text-annotation
  15. import-export-annotation
  16. ink-annotation
  17. ink-eraser
  18. line-angle-constraints
  19. measurement-annotation
  20. overview
  21. shape-annotation
  22. signature-annotation
  23. stamp-annotation
  24. sticky-notes-annotation
  25. text-markup-annotation

Annotation Types Samples:

  1. area-annotation
  2. arrow-annotation
  3. circle-annotation
  4. distance-annotation
  5. free-text-annotation
  6. highlight-annotation
  7. ink-annotation
  8. line-annotation
  9. perimeter-annotation
  10. polygon-annotation
  11. radius-annotation
  12. rectangle-annotation
  13. redaction-annotation
  14. squiggly-annotation
  15. stamp-annotation
  16. sticky-notes
  17. strikethrough-annotation
  18. underline-annotation
  19. volume-annotation

Export-Import Samples:

  1. export-annotation
  2. export-import-events
  3. import-annotation

Prompt:

Review the following developer documentation for quality and completeness.
Do not rewrite or elaborate — just identify and list issues that need correction,
organized by category:

  1. MISSING STEPS - Any step a developer would need to complete the task that isn't documented - Implicit prerequisites (installs, config, permissions) not stated - Steps that assume prior knowledge without a link/reference
  2. MISSING INFORMATION - Undocumented parameters, props, return values, or config options - Missing code examples where behavior is non-obvious - Missing version/compatibility notes (framework versions, package versions) - Missing error handling or troubleshooting guidance - Broken or missing links/references
  3. TECHNICAL ACCURACY - Code samples that won't run as-is (syntax errors, outdated APIs, wrong imports) - Inconsistencies between text description and code sample - Outdated instructions (deprecated methods, old package names)
  4. GRAMMATICAL / LANGUAGE ISSUES - Grammar, spelling, punctuation errors - Awkward phrasing or unclear sentences - Inconsistent terminology (e.g., same concept called two different names) - Inconsistent formatting (heading case, code block style, tone)
  5. STRUCTURE / CLARITY - Logical ordering issues (step B before step A) - Redundant or duplicated content - Sections that don't match their heading

OUTPUT FORMAT:
For each issue found, list:- [Category] Location (section/heading/line) — Issue — Suggested fix (one line)

Keep the fix suggestions brief (one line each). Do not add general commentary,
praise, or lengthy explanations — just the issue list. If a category has no
issues, state "No issues found" under that heading.

Documentation to review:
[PASTE DOCUMENTATION HERE]

@Dhanush-git26
Task(1043185): Revamped the UG documentation for the Annotation, Anno…
417ca8b 
…tation Types, and Export/Import samples on the Angular platform.
@SyncfusionBuild

SyncfusionBuild commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043185-RevampAngular2
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 1
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043185-RevampAngular2
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 1
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

The running CI Job is terminated due to changes committed on the source branch for this Merge Request and CI triggered for latest commit.

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@Dhanush-git26 Dhanush-git26 reopened this Jul 24, 2026
@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

The CI Job is already running for this Pull Request/Merge Approved with latest commit id. You cannot trigger the duplicate job for same.

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

The running CI Job is terminated due to changes committed on the source branch for this Merge Request and CI triggered for latest commit.

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

The running CI Job is terminated due to changes committed on the source branch for this Merge Request and CI triggered for latest commit.

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: EJ2-1043185-RevampAngular2
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

AnanthaGokulaRaman
AnanthaGokulaRaman requested changes Jul 24, 2026
View reviewed changes
Comment thread Document-Processing/PDF/PDF-Viewer/angular/annotation/annotation-comment-filter.md
Comment thread Document-Processing/PDF/PDF-Viewer/angular/annotation/annotation-comment-filter.md
Comment thread Document-Processing/PDF/PDF-Viewer/angular/annotation/annotations-api.md
Comment thread Document-Processing/PDF/PDF-Viewer/angular/annotation/create-modify-annotation.md
Creation patterns vary by type. Refer to the individual annotation pages for tailored code.

Example: creating a Rectangle annotation using [`addAnnotation`](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/index-default#addannotation).
Example: creating a Redaction annotation using [`addAnnotation`](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/index-default#addannotation).

@AnanthaGokulaRaman AnanthaGokulaRaman Jul 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@Dhanush-git26 , In the following example, only rectangle annotation is getting added, why is changed to redaction?

Comment thread Document-Processing/PDF/PDF-Viewer/angular/annotation/import-export-annotation.md
Comment thread Document-Processing/PDF/PDF-Viewer/angular/annotation/import-export-annotation.md
@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

The running CI Job is terminated due to changes committed on the source branch for this Merge Request and CI triggered for latest commit.

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: Not Started ❌
Build Location: EJ2-1043185-RevampAngular2

@SyncfusionBuild

SyncfusionBuild commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043185-RevampAngular2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AnanthaGokulaRaman AnanthaGokulaRaman AnanthaGokulaRaman requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Dhanush-git26 @SyncfusionBuild @AnanthaGokulaRaman