Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Raw > Should Be Encoded as > in Vocabulary Documentation #285

Open
Asheklm6 opened this issue Oct 23, 2024 · 3 comments
Open

[Bug] Raw > Should Be Encoded as > in Vocabulary Documentation #285

Asheklm6 opened this issue Oct 23, 2024 · 3 comments
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧹 status: ticket work required Needs more details before it can be worked on

Comments

@Asheklm6
Copy link
Contributor

Asheklm6 commented Oct 23, 2024

Description

The vocabulary/docs folder contains validation errors in HTML files, specifically related to improper character encoding and trailing whitespace. These issues may affect the rendering and validation of the documentation.

Reproduction

  1. Navigate to the vocabulary/docs folder in the project.
  2. Run an HTML validation check using the html-validate tool on the docs/index.html file.
  3. Review the error messages generated during validations.

Expectation

HTML Errors:

  • Error 1: Raw > must be encoded as "&gt";
    File: docs/index.html
    Line: 415

Screenshots

Environment

  • Device: (eg. iPhone Xs; laptop)
  • OS: (eg. iOS 13.5; Fedora 32)
  • Browser: (eg. Safari; Firefox)
  • Version: (eg. 13; 73)
  • Other info: (eg. display resolution, ease-of-access settings)

Additional context

These validation errors appear in multiple HTML files throughout the vocabulary/docs folder. Addressing these issues will improve the documentation's compliance with HTML standards.

Resolution

  • [x ] I would be interested in resolving this bug.
@Asheklm6 Asheklm6 added 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Oct 23, 2024
@possumbilities
Copy link
Contributor

Hi @Asheklm6 These are two distinct issues. At current we aren't applying a standardized formatting or analysis tool to this repo, so the trailing whitespace is likely not a huge issue, but feel free to create a separate Issue for it.

We like to keep Issues concise, so that PRs are addressing singularly focused items where possible rather than combining items at large.

@possumbilities possumbilities added 🧹 status: ticket work required Needs more details before it can be worked on 🟩 priority: low Low priority and doesn't need to be rushed and removed 🟧 priority: high Stalls work on the project or its dependents 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Oct 23, 2024
@Asheklm6 Asheklm6 changed the title [Bug] Raw > Should Be Encoded as > and Trailing Whitespace in Vocabulary Documentation [Bug] Raw > Should Be Encoded as > in Vocabulary Documentation Oct 23, 2024
@Asheklm6
Copy link
Contributor Author

@possumbilities thank you so much for the clarification, i have made changes to the issue accordingly, sonce trailingwhite space is not so muchof an issue i have only included the validation errors in the html files.

@Asheklm6
Copy link
Contributor Author

@possumbilities pls assign me this issue when approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧹 status: ticket work required Needs more details before it can be worked on
Projects
Status: Backlog
Development

No branches or pull requests

2 participants