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

docs(manifest): Improvements to shortcuts page #36034

Merged
merged 5 commits into from
Oct 8, 2024

Conversation

dipikabh
Copy link
Contributor

Description

This work is part of improving the web/manifest docs.

Apart from normalizing the page layout to include "Syntax" and "Values", this PR includes the following changes:

  • Organizes the information into a "Description" section and covers all info from the spec
  • Replaces the existing example with two examples with prose

Motivation

To ensure all sections have sufficient explanation, all caveats from spec are covered, and the pages follow a similar template

Additional details

Spec links:

Related issues and pull requests

Tracking issue: mdn/mdn#560

@dipikabh dipikabh requested a review from a team as a code owner September 24, 2024 20:05
@dipikabh dipikabh requested review from hamishwillee and removed request for a team September 24, 2024 20:05
@github-actions github-actions bot added Content:Manifest size/m [PR only] 51-500 LoC changed labels Sep 24, 2024
Copy link
Contributor

github-actions bot commented Sep 24, 2024

Preview URLs

(comment last updated: 2024-10-08 17:51:03)

@hamishwillee
Copy link
Collaborator

Looks good! I've added some suggestions.

I would be really great to see some screenshots, in particular if this behaviour is relatively stable and unlikely to change.

@dipikabh
Copy link
Contributor Author

dipikabh commented Oct 2, 2024

Thanks for reviewing, Hamish, some really great suggestions. I've made the updates and left comments if changes are slightly different from the suggestions. This is ready for another look.

(I've added the screenshot idea to my list for doing something similar for icons and display pages.)

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

Looks great. I merged a couple of minor "clear fixes". This one is for discussion https://github.com/mdn/content/pull/36034/files#r1791057357 - but I have approved so you can merge after looking at it.

@dipikabh
Copy link
Contributor Author

dipikabh commented Oct 8, 2024

Thanks, @hamishwillee, for helping get this across the finish line 🙌

@dipikabh dipikabh merged commit 0d056d9 into mdn:main Oct 8, 2024
8 checks passed
@dipikabh dipikabh deleted the manifest-shortcuts branch October 8, 2024 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Manifest size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants