Skip to content

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Oct 2, 2025

Overview

This PR addresses documentation quality issues in the eclipse.platform.common/bundles directory by fixing spelling errors, verifying HTML structure, and documenting areas requiring manual review.

Changes Made

Spelling Corrections (65 errors fixed across 53 files)

Fixed common spelling errors throughout the documentation including:

  • implementor/implementorsimplementer/implementers
  • certficatescertificates
  • paramter/paramaterparameter
  • programaticallyprogrammatically
  • accessibiliityaccessibility
  • witoutwithout
  • occuredoccurred
  • thiertheir
  • overlayedoverlaid
  • BackgourndBackground
  • And 50+ other common typos

These corrections improve readability and professionalism across user-facing and developer documentation.

Files Modified

  • 31 files in first commit (common typos like implementor, cancelation, capabilites)
  • 14 files in second commit (additional typos like programatically, accomodate, threshhold)
  • 8 files in third commit (final typos like expaned, overlayed, showin)

Documentation Added

Added DOCUMENTATION_CHECK_RESULTS.md providing:

  • Complete list of all corrections made
  • Analysis of remaining 98 "spelling errors" (mostly false positives: technical abbreviations, API class names)
  • Identification of potentially outdated Oracle documentation links requiring manual verification
  • Recommendations for future documentation maintenance

Verification

  • Scanned all 1,244 HTML files in the bundles directory using codespell
  • Reduced spelling errors from 163 to 98 (40% reduction)
  • Verified HTML structure remains valid
  • Confirmed historical version references (J2SE, Eclipse 4.x) are appropriate and should not be changed

Remaining Items (For Future PRs)

The results document identifies items requiring manual review:

  1. Oracle documentation links - URLs like oracle.com/technetwork/java/* may need updating to current docs locations
  2. Remaining "errors" - 98 items are mostly false positives (NCE abbreviations, API class names like "CompletionRequestor")

Testing

  • All changes are text-only corrections with no functional impact
  • HTML files remain structurally valid
  • Historical documentation references preserved appropriately

Fixes #<issue_number>

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • www.oracle.com
    • Triggering command: curl -s -o /dev/null -w %{http_code} -L REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Check the documentation at eclipse.platform.common/bundles

The folder eclipse.platform.common/bundles in this repository contains the documentation of the eclipse platform as part of html documents.

The documentation should be checked:

  • for spelling errors
  • outdated information
  • general html problems or dead links

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot Copilot AI assigned Copilot and laeubi Oct 2, 2025
@Copilot Copilot AI changed the title Check the documentation at eclipse.platform.common/bundles The folder eclipse.platform.common/bundles in this repository contains the documentation of the eclipse platform as part of html documents. The documentation should be checked: - for spelling... Fix spelling errors and improve documentation quality in eclipse.platform.common/bundles Oct 2, 2025
@Copilot Copilot AI requested a review from laeubi October 2, 2025 07:58
Copilot finished work on behalf of laeubi October 2, 2025 07:58
@akurtakov akurtakov force-pushed the copilot/fix-b6f246ca-7a9f-4a55-878b-4503bf934a3e branch from e840cfd to ffe76d9 Compare October 3, 2025 08:57
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