Skip to content

1044525- Revamp UG Documentation for forms, interaction and localization samples in Typescript Platform - #4044

Open
Logeshwaran-SyncGit wants to merge 6 commits into
developmentfrom
EJ2-1044525-RevampTS2
Open

1044525- Revamp UG Documentation for forms, interaction and localization samples in Typescript Platform#4044
Logeshwaran-SyncGit wants to merge 6 commits into
developmentfrom
EJ2-1044525-RevampTS2

Conversation

@Logeshwaran-SyncGit

Copy link
Copy Markdown
Collaborator

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

Files Covered:

  1. export-form-fields
  2. import-export-events
  3. import-form-fields
  4. create-form-fields
  5. customize-form-fields
  6. modify-form-fields
  7. move-resize-form-fields
  8. remove-form-fields
  9. custom-data
  10. form-constrain
  11. form-designer
  12. form-field-events
  13. form-fields-api
  14. form-filling
  15. form-validation
  16. group-form-fields
  17. overview-create-forms
  18. overview
  19. bookmark
  20. hyperlink
  21. page-thumbnail
  22. default-language
  23. new-language
  24. rtl-language-support

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-1044525-RevampTS2

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

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

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

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