Skip to content

[Docs] Adding new Writing for Accessibility page #1295

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

Merged
merged 1 commit into from
Mar 26, 2025

Conversation

juliavs85
Copy link
Contributor

Adding a new page to the Product Writing Guidelines.

Copy link

netlify bot commented Mar 13, 2025

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 99ad06b
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/67e3c064422dc20008b86e7b
😎 Deploy Preview https://deploy-preview-1295--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@timhunt
Copy link
Collaborator

timhunt commented Mar 13, 2025

Thanks for doing this. Looks good. A few suggestions:

  • "Learn more about all our plans" in a 'good' example. I feel like this would be an even better example if you removed the word "all".
  • The "HTML page titles" contracticts how Moodle currently works and good practice. "Manage activities" is not a good page title. (Suppose you are trying to compare things between, say Moodle academy and Moodle.org. It should be something like "Manage activities | Course: Set up your Moodle Development Environment | Moodle Academy" - which is pretty much what Moodle currently does. Oh! your later example in this section say that. I think it is bad to start with some misleading 'Good' examples.

@juliavs85
Copy link
Contributor Author

juliavs85 commented Mar 13, 2025

Hi Tim!

Thanks so much for your feedback.

  • "Learn more about all our plans" in a 'good' example. I feel like this would be an even better example if you removed the word "all".

Yes, agreed.

  • The "HTML page titles" contracticts how Moodle currently works and good practice. "Manage activities" is not a good page title. (Suppose you are trying to compare things between, say Moodle academy and Moodle.org. It should be something like "Manage activities | Course: Set up your Moodle Development Environment | Moodle Academy"

And yes, I agree with that too. I was only focusing on that specific part of the page title, but I see how it is misleading, and the good example should be a FULL good example.

I'll push these changes.

@timhunt
Copy link
Collaborator

timhunt commented Mar 26, 2025

Those chagnes look good to me. THanks @juliavs85.

Copy link
Collaborator

@timhunt timhunt left a comment

Choose a reason for hiding this comment

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

This looks good to me. Am I OK to add an approving review?

@sarjona sarjona added this pull request to the merge queue Mar 26, 2025
Merged via the queue into moodle:main with commit 7cbc598 Mar 26, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants