Skip to content

Task(1044131): Revamp UG documentation for open, save pdf files, toolbar and troubleshooting samples in Core platform - #3976

Open
Logeshwaran-SyncGit wants to merge 7 commits into
developmentfrom
EJ2-1044131-CoreRevamp4
Open

Task(1044131): Revamp UG documentation for open, save pdf files, toolbar and troubleshooting samples in Core platform#3976
Logeshwaran-SyncGit wants to merge 7 commits into
developmentfrom
EJ2-1044131-CoreRevamp4

Conversation

@Logeshwaran-SyncGit

Copy link
Copy Markdown
Collaborator

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

Files Covered:

  1. to-amazon-s3
  2. to-azure-active-directory
  3. to-azure-blob-storage
  4. to-box-cloud-file-storage
  5. to-google-cloud-storage
  6. to-google-drive
  7. from-amazon-s3
  8. from-azure-active-directory
  9. from-azure-blob-storage
  10. from-box-cloud-file-storage
  11. from-google-cloud-storage
  12. from-google-drive
  13. annotation-toolbar
  14. custom-toolbar
  15. form-designer-toolbar
  16. mobile-toolbar
  17. primary-toolbar
  18. document-loading-issues
  19. accessibility
  20. download
  21. event
  22. feature-module
  23. globalization
  24. how-to-overview
  25. interaction-mode
  26. magnification
  27. mobile-toolbar
  28. navigation
  29. open-pdf-file
  30. organize-pdf-overview
  31. organize-pdf
  32. overview
  33. print
  34. server-actions
  35. server-to-standalone
  36. text-markup-annotation
  37. text-search
  38. textselection
  39. toolbar

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-1044131-CoreRevamp4

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

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

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

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

2 participants