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): Improve display member page #34386

Merged
merged 4 commits into from
Jul 9, 2024

Conversation

dipikabh
Copy link
Contributor

Description

This work is part of improving the web/manifest docs. This PR focuses on the display member page.

A few notable changes done in this PR:

  • Formatting/layout changes:

    • Removed the "Type" table from the top of the page. The type can be covered in the Syntax section and does not need a table. (On some other pages like file_handlers, this Type table overcrowds with technology status banners.)
    • Created a "Syntax" section with a "Values" subsection. Removed the table describing the values, instead added a definition list format for explaining the values.
    • Created a "Description" section to include additional info about the member instead of using "Notes".
  • Content improvements:

    • For each value, added an example scenario where the value might be used
    • Removed the two notes at the top of the page and moved them into the "Values" and "Description" sections, respectively.
    • Added two missing caveats from the spec:
      • One about fullscreen vs Fullscreen API
      • The other about display-mode media feature vs display manifest member
    • Added a more complete example to show the display member in context with other members of the manifest file.

Motivation

To add more usage examples, update information from spec, make the page compliant with our page templates

Additional details

Related issues and pull requests

mdn/mdn#560

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

github-actions bot commented Jun 24, 2024

Preview URLs

(comment last updated: 2024-07-09 12:22:51)

Copy link
Member

@pepelsbey pepelsbey left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you :)

files/en-us/web/manifest/display/index.md Outdated Show resolved Hide resolved
Co-authored-by: Vadim Makeev <hi@pepelsbey.dev>
@dipikabh
Copy link
Contributor Author

dipikabh commented Jul 9, 2024

Thanks a lot for the review, @pepelsbey.

@dipikabh dipikabh merged commit 0680631 into mdn:main Jul 9, 2024
8 checks passed
evelinabe pushed a commit to evelinabe/mdn-content that referenced this pull request Jul 12, 2024
* improves manifest display page

* adjust desc and value

* fix typo

* Update files/en-us/web/manifest/display/index.md

Co-authored-by: Vadim Makeev <hi@pepelsbey.dev>

---------

Co-authored-by: Vadim Makeev <hi@pepelsbey.dev>
@dipikabh dipikabh deleted the manifest-display branch September 10, 2024 22:46
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