Skip to content

Fixing a few typo's ✏️ #622

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

JamieB101
Copy link

Copy link
Collaborator

@danuw danuw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for those changes. Can you double check the documentation compiles with those '<' and '>' or is this why you are adding them in please ?

@danuw
Copy link
Collaborator

danuw commented Apr 8, 2025

Thank you. can you fix the DCO or confirm for me to override in here please?

@danuw
Copy link
Collaborator

danuw commented Apr 15, 2025

@JamieB101 can you confirm about the DCO please? Either update to ensure your changes are signed or confirm here you are happy for me to override

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses a few typographical errors and formatting updates in the project documentation. The key changes include updates to link formatting in SECURITY.md, corrections to typos in documentation text, and a revised screenshot label in README.md.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
SECURITY.md Updated link formatting and fixed minor typos for clarity.
README.md Corrected subject/verb agreement and updated the screenshot label.
Comments suppressed due to low confidence (1)

README.md:81

  • Please confirm that the updated screenshot label accurately reflects the intended image. Ensure that the image depicts a CLI interface if 'CLI Screenshot' is used.
![CLI Screenshot](./images/readme/screenshot_cli.png)

@danuw
Copy link
Collaborator

danuw commented May 27, 2025

@JamieB101 we are still waiting on your update to the DCO or approval to override please?

@vaughanknight
Copy link
Contributor

Some of the updates impact formatting, I suggest we create a separate PR with the spelling fixes and it also gets around DCO issues as we haven't had a response.

@danuw
Copy link
Collaborator

danuw commented Jun 10, 2025

Ok we might just recreate this PR then and fix the typos (there are some angle brackets that will break the docs and prevent from building.
Thank you for your help though and for highlighting the typos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants