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 orientation page #35977

Merged
merged 5 commits into from
Oct 1, 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:

  • Explains all the orientation values
  • Adds a "Description" section to show a visual representation of the orientations and cover all the info from the spec
  • Adds prose to the existing example in "Examples" and adds another example with a scenario to explain the concept

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

Fixes #34927

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

github-actions bot commented Sep 20, 2024

Preview URLs

(comment last updated: 2024-10-01 16:20:54)

Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

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

Hi @dipikabh! Thanks for your awesome work on this, such an improvement on the existing manifest pages. I love that you are taking this on.

I have some comments for you — mostly not serious.

files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Sep 24, 2024
@dipikabh
Copy link
Contributor Author

Hi Chris, thanks for the excellent review suggestions and questions. I ended up redoing a lot of content, so it took a bit longer.
I'd appreciate if you can take another look to see if it makes sense now. Thanks!!

Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

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

@dipikabh wonderful work, Dipika. I just noticed a couple more small typos. Approving, so you can merge when you've considered those.

files/en-us/web/manifest/orientation/index.md Outdated Show resolved Hide resolved
@dipikabh
Copy link
Contributor Author

dipikabh commented Oct 1, 2024

Thanks @chrisdavidmills for taking a look at all the updates and going through the page again. Merging this shortly.

@dipikabh dipikabh merged commit 97391fc into mdn:main Oct 1, 2024
8 checks passed
@dipikabh dipikabh deleted the manifest-orientation branch October 1, 2024 16:57
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.

Descriptions of orientation values missing
2 participants