Skip to content

1043948- Revamp UG documentation for How-To samples in Core platform - #3949

Open
Logeshwaran-SyncGit wants to merge 9 commits into
developmentfrom
EJ2-1043948-RevampCore3
Open

1043948- Revamp UG documentation for How-To samples in Core platform#3949
Logeshwaran-SyncGit wants to merge 9 commits into
developmentfrom
EJ2-1043948-RevampCore3

Conversation

@Logeshwaran-SyncGit

Copy link
Copy Markdown
Collaborator

1043948: Resolve Documentation Issues for EJ2 PDF Viewer
Task Link: https://dev.azure.com/EssentialStudio/Ej2-Web/_workitems/edit/1043948

Files Covered:

  1. add-annotation-in-text-search
  2. add-save-button
  3. authorization-token
  4. capture-page-number
  5. configure-annotation-selector-setting
  6. control-annotation-visibility
  7. convert-pdf-library-bounds-to-pdf-viewer-bounds
  8. custom-context-menu
  9. custom-font-signature-field
  10. custom-fonts
  11. customize-text-search-color
  12. delete-a-specific-annotation
  13. disable-context-menu
  14. disable-tile-rendering
  15. display-document-without-downloading
  16. download-start-event
  17. enable-local-storage
  18. enable-resize
  19. enable-text-selection
  20. export-as-image-standalone
  21. export-as-image
  22. extract-text-completed
  23. extract-text-option
  24. extract-text-using-text-collections
  25. extract-text
  26. find-text-async
  27. get-base64
  28. get-page-info
  29. identify-added-annotation-mode
  30. import-export-annotation
  31. install-packages
  32. Instantiate-pdfviewer-dynamically
  33. load-document-after-resources-loaded
  34. load-documents
  35. load-n-number-page
  36. local-resources
  37. min-max-zoom
  38. open-bookmark
  39. open-thumbnail
  40. overlapped-annotation
  41. pagerenderstarted-pagerendercompleted
  42. print-document
  43. resolve-pdfium-issue
  44. resolve-Unable-to-find-an-entry-point-error
  45. restricting-zoom-in-mobile-mode
  46. retry-timeout
  47. save-original-document-at-the-server-side
  48. select-multi-page-annotations
  49. show-bookmark
  50. show-custom-stamp-item
  51. show-hide-annotation
  52. signatureselect-signatureunselect
  53. unload-document
  54. 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

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

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

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: EJ2-1043948-RevampCore3
Technical Error(s): 0
Spelling Error(s): 1
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

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: EJ2-1043948-RevampCore3
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): 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

Comment thread Document-Processing/PDF/PDF-Viewer/asp-net-core/how-to/custom-context-menu.md Outdated
Comment thread Document-Processing/PDF/PDF-Viewer/asp-net-core/how-to/custom-context-menu.md Outdated
@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

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

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

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

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

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

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: Not Started ❌
Build Location: EJ2-1043948-RevampCore3

@Logeshwaran-SyncGit

Copy link
Copy Markdown
Collaborator Author

rebuild

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

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

Copy link
Copy Markdown
Contributor

CI Status: ABORTED ❌
Source Compilation: FAILURE ❌
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: EJ2-1043948-RevampCore3

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: EJ2-1043948-RevampCore3
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): 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

Sign up for free to 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.

3 participants