Skip to content

Task(1043618): Revamped the UG documentation for the How-To samples in the Angular PDF Viewer platform - #3898

Open
Dhanush-git26 wants to merge 11 commits into
developmentfrom
EJ2-1043618-RevampAngular7
Open

Task(1043618): Revamped the UG documentation for the How-To samples in the Angular PDF Viewer platform#3898
Dhanush-git26 wants to merge 11 commits into
developmentfrom
EJ2-1043618-RevampAngular7

Conversation

@Dhanush-git26

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

Copy link
Copy Markdown
Collaborator

1043468: Revamped the UG documentation for the How-To samples in the Angular PDF Viewer platform:
Task Link: https://dev.azure.com/EssentialStudio/Ej2-Web/_workitems/edit/1043618/

Files to be covered: 53

How-To Samples:

  1. add-annotation-in-text-search
  2. add-header-value
  3. annotation-selectors
  4. change-author-name-using-annotation-selector
  5. change-selection-border
  6. configure-annotation-selector-setting
  7. conformance
  8. control-annotation-visibility
  9. convert-pdf-library-bounds-to-pdf-viewer-bounds
  10. create-a-standalone-pdf-viewer-in-angular-12
  11. create-a-standalone-pdf-viewer-in-angular-17-and-above-with-no-standalone-flag
  12. create-a-standalone-pdf-viewer-in-angular-17-and-above-without-no-standalone-flag
  13. custom-context-menu
  14. custom-fonts
  15. custom-font-signature-field
  16. custom-stamp
  17. delete-annotation
  18. download-start-event
  19. enable-disable-annotation
  20. enable-local-storage
  21. enable-text-selection
  22. export-as-image
  23. extract-text
  24. extract-text-completed
  25. extract-text-option
  26. find-text-async
  27. font-family
  28. get-base64
  29. get-base-string-of-the-loaded-document
  30. getPageInfo
  31. import-export-annotation
  32. include-authorization-token
  33. install-packages-required-for-lower-versions
  34. load-document
  35. load-document-after-resources-loaded
  36. load-n-number-page
  37. load-office-files
  38. load-pdf-viewer-with-local-resources
  39. lock-annotation-in-a-document
  40. lock-formfield-in-a-document
  41. min-max-zoom
  42. open-bookmark
  43. open-thumbnail
  44. pagerenderstarted-pagerendercompleted
  45. redis-cache
  46. resolve-unable-to-find-an-entry-point-error
  47. restricting-zoom-in-mobile-mode
  48. retry-timeout
  49. show-custom-stamp-item
  50. show-pop-up-after-completion-of-export-form-fields
  51. signatureselect-signatureunselect
  52. unload-document
  53. webservice-not-listening

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]

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 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 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 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 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 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 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043618-RevampAngular7
Technical Error(s): 0
Spelling Error(s): 2
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 36
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 27, 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 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: Not Started ❌
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: Not Started ❌
Build Location: EJ2-1043618-RevampAngular7

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

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 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 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043618-RevampAngular7
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 7
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 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043618-RevampAngular7
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 4
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 27, 2026

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043618-RevampAngular7

@SyncfusionBuild

SyncfusionBuild commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043618-RevampAngular7
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 1
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

@Dhanush-git26 Dhanush-git26 added documentation Improvements or additions to documentation cs:used AI was used in this PR labels Jul 28, 2026
@Dhanush-git26 Dhanush-git26 reopened this Jul 28, 2026
@Dhanush-git26 Dhanush-git26 reopened this Jul 28, 2026
@Dhanush-git26 Dhanush-git26 reopened this Jul 28, 2026
@Dhanush-git26 Dhanush-git26 reopened this Jul 28, 2026
@Dhanush-git26 Dhanush-git26 reopened this Jul 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cs:used AI was used in this PR documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Dhanush-git26 @SyncfusionBuild