Fixes #283 [Lot of encoding errors on docs/index.html]

[rahulptl165]

Fixes

• Fixes [Bug] Lot of encoding errors on docs/index.html #283 by @OmarAmeen01

Description

This PR addresses several HTML validation issues found in docs/index.html, including encoding errors, missing required attributes, and improper tag usage. The following changes have been made:

1. Encoding Errors: Fixed instances where raw characters like > were not encoded as >

2. Self-closing Tags: Updated <img /> and <link /> elements to proper non-self-closing tags.

3. Missing alt Attributes: Added missing alt attributes to <img> tags for accessibility.

4. Trailing Whitespace: Removed trailing whitespace from several lines to maintain clean formatting.

5. Landmark Accessibility: Added missing aria-label attributes to landmark elements for better accessibility.

6. Ignored Errors: The issue regarding <article>, <aside>, <nav>, and <header> elements being used inside <code> tags is intentional and will be ignored.

Tests

1. Visual Check: Manually inspected docs/index.html to verify proper rendering of the file and ensure there are no visual regressions.
2. Accessibility: Used an accessibility checker to verify that all landmark elements have the correct aria-label attributes and that all <img> tags now have alt attributes.
3. HTML Validation: Ran html-validate on docs/index.html to confirm the encoding issues, self-closing tag issues, and trailing whitespace issues were resolved.

Screenshots

only errors related to " element is not permitted as content under <code> " due to <article>, <aside>, <nav>, and <header> elements being used inside <code> tags.

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main or master).
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no
  visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[netlify]

✅ Deploy Preview for vocabulary-docs ready!

Name	Link
🔨 Latest commit	71f45e3
🔍 Latest deploy log	https://app.netlify.com/sites/vocabulary-docs/deploys/672e4a05cc25a600089ea525
😎 Deploy Preview	https://deploy-preview-314--vocabulary-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[egbadon-victor]

Hi @rahulptl165

Based on the contributor guidelines, you should only submit PRs for issues labelled Status: Ready for work or help wanted. You could try looking for issues with the appopriate label and then submitting a PR for them. This one is labelled with Status: ticket work required

[possumbilities]

@rahulptl165 Please see the original Issue which is still set to 🧹 status: ticket work required Needs more details before it can be worked on

Please see the Contribution Guidelines for more information.

Closing for now.

[rahulptl165]

Hi @egbadon-victor , Thank you for the clarification! I’ll review the contributor guidelines thoroughly and focus on issues labeled Status: Ready for work or help wanted. I’ll avoid issues marked Status: ticket work required for now.

Thanks again for the guidance!