Skip to content

Task(1043536): Revamped the UG documentation for the core Angular PDF Viewer documentation pages - #3918

Open
Dhanush-git26 wants to merge 2 commits into
developmentfrom
EJ2-1043536-RevampAngular8
Open

Task(1043536): Revamped the UG documentation for the core Angular PDF Viewer documentation pages#3918
Dhanush-git26 wants to merge 2 commits into
developmentfrom
EJ2-1043536-RevampAngular8

Conversation

@Dhanush-git26

Copy link
Copy Markdown
Collaborator

1043536: Revamped the UG documentation for the core Angular PDF Viewer documentation pages
Task Link: https://dev.azure.com/EssentialStudio/Ej2-Web/_workitems/edit/1043536/

Files to be covered: 17

Core Documentation Files

  1. accessibility
  2. download
  3. events
  4. feature-module
  5. how-to-overview
  6. interaction-mode
  7. magnification
  8. mobile-toolbar
  9. module-injection
  10. navigation
  11. open-pdf-files
  12. overview
  13. save-pdf-files
  14. server-to-standalone
  15. theming-and-styling
  16. toolbar
  17. ui-builder-skill

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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant