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

Cleaned up README and added startpage #322

Merged
merged 10 commits into from
Mar 26, 2021

Conversation

codepo8
Copy link
Contributor

@codepo8 codepo8 commented Mar 25, 2021

This change cleans out the README of outdated and overly complicated information and adds new screencasts and screenshots instead.
There's also a new optional startpage to show when opening the tools.

This change cleans out the README of outdated and overly complicated information and adds new screencasts and screenshots instead.
There's also a new optional startpage to show when opening the tools.
@codepo8 codepo8 requested review from mliao95 and vidorteg March 25, 2021 14:17
Copy link

@mliao95 mliao95 left a comment

Choose a reason for hiding this comment

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

Left some comments.

@@ -109,45 +105,39 @@ Attach the extension to your live reloading project
* Navigate in the browser of the extension to `localhost:8080/{file name you want to open}`
* All changes that are saved in this folder now trigger a refresh

#### Opening source files from the Elements tool
## Changing Extension Settings
Copy link

Choose a reason for hiding this comment

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

We also have this entrypoint!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not in the current version, yet.
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added the screencast and changed the text accordingly.

README.md Outdated

An example webpack configuration for sass and typescript is given below:
You can enable the Network Pane to inspect any network request of the attached browser. To do this, change the setting and restart the extension.
Copy link

Choose a reason for hiding this comment

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

NIT: Network is enabled by default and this section gives the impression that it isn't.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed and removed the extra screencast

* `urlFilter`: A string that can contain wildcards that will be used for finding a browser target, for example, "localhost:*/app" will match either "http://localhost:123/app" or "http://localhost:456/app", but not "https://stackoverflow.com". This property will only be used if `url` and `file` are not specified.
* `timeout`: The number of milliseconds that the Microsoft Edge Tools will keep trying to attach to the browser before timing out. Defaults to 10000ms.

#### Sourcemaps
Copy link

Choose a reason for hiding this comment

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

Maybe move to a SourceMaps.md file and reference it where necessary

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

* Debug using a windowed or headless version of the Microsoft Edge Browser
* Side Bar view for listing all the debuggable targets, including tabs, extensions, service workers, etc.
Copy link

Choose a reason for hiding this comment

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

As a note, service and shared workers are hidden from the target list by default and can be enabled via settings. Up to you whether we want to publicize a disabled-by-default functionality.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's not for now, and maybe think about how we could make that more interesting. As we don't have the applications tab for debugging service workers it seems superfluous.

@mliao95 mliao95 self-requested a review March 25, 2021 19:23
Copy link

@mliao95 mliao95 left a comment

Choose a reason for hiding this comment

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

LGTM. The new pages look great! Thanks!

Copy link
Contributor

@vidorteg vidorteg 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!

@mliao95 mliao95 merged commit a9c15f0 into master Mar 26, 2021
@mliao95 mliao95 modified the milestones: 1.1.7, 1.1.6 Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants