Clarify Readme steps to add new sample#137
Conversation
mikehoffms
left a comment
There was a problem hiding this comment.
LGTM - Content Developer/ Writer/Editor
Rewrites and expands the demo creation steps in README.md for clarity. Changes include: consistently referring to the demo README as `README.md`, instructing how to modify the GitHub.io link to match your directory name, adding a note that the GitHub Pages demo becomes available about an hour after merge with an Actions link, listing example files commonly found in a demo directory (index.html, style.css, foo.js, README.md, manifest.json), and emphasizing creation of a pull request for review. These edits improve guidance for contributors adding new demos.
| | Feature | Description | Documentation | | ||
| |---|---|---| | ||
| | Web Install API | PWA installer uses the `navigator.install()` API to install other PWAs on the device. | [Web Install API](https://github.com/MicrosoftEdge/MSEdgeExplainers/blob/main/WebInstall/explainer.md) | | ||
| | CSS Masonry | Instead of a strict grid that has gaps below shorter items, the items in the following row are raised up to fill the gaps. | [Masonry layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Masonry_layout) | |
There was a problem hiding this comment.
| | CSS Masonry | Instead of a strict grid that has gaps below shorter items, the items in the following row are raised up to fill the gaps. | [Masonry layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Masonry_layout) | | |
| | CSS Masonry | Instead of a strict grid that has gaps below shorter items, the items fill the columns in the layout to avoid gaps. | [Masonry layout](https://developer.mozilla.org/docs/Web/CSS/CSS_grid_layout/Masonry_layout) | |
| To open and run the sample: | ||
|
|
||
| 1. In the browser, open a new tab and go to `about:flags`. | ||
| 1. Go to [Open the demo](https://microsoftedge.github.io/Demos/pwa-installer/). |
There was a problem hiding this comment.
| 1. Go to [Open the demo](https://microsoftedge.github.io/Demos/pwa-installer/). | |
| 1. Go to [PWA Installer](https://microsoftedge.github.io/Demos/pwa-installer/). |
| 1. Open a new tab, and then go to `about:flags`. | ||
|
|
||
| You end up at `edge://flags`. |
There was a problem hiding this comment.
| 1. Open a new tab, and then go to `about:flags`. | |
| You end up at `edge://flags`. | |
| 1. Open a new tab, and then go to `edge://flags`. |
| 1. In the browser, open a new tab and go to `about:flags`. | ||
|
|
||
| In Microsoft Edge, you end up at `edge://flags`. | ||
| You end up at `edge://flags`. | ||
|
|
||
| 1. In the **Search** box, enter **css-masonry-layout**. | ||
|
|
||
| 1. Set the **CSS Masonry Layout** flag to **Enabled**. | ||
|
|
||
| 1. Click the **Restart** button in the lower right. The browser restarts. | ||
| 1. Click the **Restart** button in the lower right. | ||
|
|
||
| The browser restarts. |
There was a problem hiding this comment.
Can we tell users to enable both flags at the same time, while they're on the edge://flags page? Right now, we're telling them to do the steps twice in a row (open edge://flags, set a flag, restart, and then open edge://flags, set another flag, restart again)
| * [By the Light of the Silvery Moon - Fats Waller](web+amp:remote-song:ia803003.us.archive.org/17/items/78_by-the-light-of-the-silvery-moon_fats-waller-and-his-rhythm-fats-waller-the-dee_gbia0153541a/BY%20THE%20LIGHT%20OF%20THE%20SILVERY%20-%20%22Fats%22%20Waller%20and%20his%20Rhythm.mp3). | ||
|
|
||
| * To edit song information, click on the artist, title, or album fields and edit the text. | ||
| * The title bar becomes able to be displayed or hidden. To hide the title bar, in the toolbar, click the chevron (>>) icon. |
There was a problem hiding this comment.
| * The title bar becomes able to be displayed or hidden. To hide the title bar, in the toolbar, click the chevron (>>) icon. | |
| * The title bar can be displayed or hidden. To hide the title bar, in the toolbar, click the chevron (^) icon. |
|
|
||
| <!-- ====================================================================== --> | ||
| ## Making a new skin | ||
| ## Open the sample |
There was a problem hiding this comment.
I think it would be good to make this section appear earlier in the readme. The most important thing we want users to do on the repo is open samples.
|
|
||
|
|
||
| <!-- ------------------------------ --> | ||
| ### Record an audio clip |
There was a problem hiding this comment.
We don't really need to document all the features of the app. Some of them are not useful to learn about integrating a PWA in Windows (which this sample is about).
| wami is an image manipulation demo application. It is an installable web app (PWA) specifically made to demonstrate that web technologies can be used to create desktop apps that feel like platform-specific apps. | ||
|
|
||
|  |
There was a problem hiding this comment.
This should be moved up into the "About this sample" section.
Related PRs:
Rendered page for review:
~/README.mdAB#62380953