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 brush up #159

Merged
merged 4 commits into from
Sep 11, 2024
Merged

Docs brush up #159

merged 4 commits into from
Sep 11, 2024

Conversation

Jay-o-Way
Copy link
Contributor

@Jay-o-Way Jay-o-Way commented Aug 31, 2024

General brush up of some MD files. Improving sentences/spelling, markdown formatting, using "images" folder.
Using a few guides from https://learn.microsoft.com/contribute/content/markdown-reference.

Notes (for later)

  • check this sentence:
    Right-clicking on the browser that has `AlternateLauches` brings up the context menu with options specified as in the settings file. On selecting the the URL will also automatically included while launching the browser.
  • update images to latest version (especially at v1.0)
  • update info on how to enable Chrome Developer Mode, and how to install the extension
  • check/update recent code changes (like new MinimizeOnFocusLoss)
  • I'll leave SECURITY.md and WIKI up to you - Maybe even move all these docs to WIKI?

@Jay-o-Way Jay-o-Way marked this pull request as draft August 31, 2024 14:57
@U-C-S
Copy link
Owner

U-C-S commented Aug 31, 2024

Thank you, I'll take a look soon. I wanted to continue polishing it to a standard over the week. you read my mind haha.

@Jay-o-Way Jay-o-Way force-pushed the docs-brush-up branch 2 times, most recently from babf16e to bae4c39 Compare August 31, 2024 15:19
@Jay-o-Way Jay-o-Way marked this pull request as ready for review August 31, 2024 15:19
@Jay-o-Way
Copy link
Contributor Author

Yeah, not much changes in the content here. If there are actual new or changed things, you can add that.


- `LaunchUnderMouse` default is **false**, can be used to launch the Hurl window under the mouse when enabled
- `MinimizeOnFocusLoss` default is **true**
- `NoWhiteBorder` set **true** or **false** to enable or disable the white border around the window
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should be looked at: do you show or hide the border? And is it even there in the latest UI?

Copy link
Owner

Choose a reason for hiding this comment

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

show or hide the border?

Yes, the one around the select browser window

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I mean: true = show or true = hide?

Copy link
Owner

Choose a reason for hiding this comment

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

Oh I see, I worded it confusing.

true=hide

@@ -1,15 +1,16 @@
# Hurl Extension
# Hurl browser extension

This browser extension uses Native Messaging API to communicate with the Hurl Application.

## Installation

To use it in Chrome, follow the steps below:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These steps seem to be seriously outdated?

Copy link
Owner

Choose a reason for hiding this comment

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

I updated them recently. If anything, I might have missed on adding a step in middle.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I know why I can't find Dev Mode - I already have it on 😆

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@U-C-S
Copy link
Owner

U-C-S commented Sep 2, 2024

Utils\Readme.md can be removed (?)

This is used by inno setup as a pre-install message.

update info on how to enable Chrome Developer Mode, and how to install the extension

I think extension readme is fine as it is, whether moving it under Docs is something to consider, including Hurl local development docs.

I'll leave SECURITY.md and WIKI up to you - Maybe even move all these docs?

I will probably remove SECURITY.md, I don't know why I added it in the first place

Comment on lines +1 to +5
# Hurl

<h1 align="center">Hurl</h1>
A Windows utility that lets you choose a browser on the click of a link.

<p align="center">A windows utility that lets you choose a browser on the click of a link</p>
![Hurl Icon](Source/Hurl.BrowserSelector/Assets/internet.ico)
Copy link
Owner

Choose a reason for hiding this comment

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

I prefer the Icon/Logo is either centered or in a two column layout as it was previously.

So you can leave it as it was earlier. but open to any suggestions here

Copy link
Contributor Author

@Jay-o-Way Jay-o-Way Sep 10, 2024

Choose a reason for hiding this comment

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

By default, all text in Markdown fields are aligned to the left. A Markdown image inside HTML tags does not work. In general, HTML is unrecommended anyway. More info: https://github.github.com/gfm/#html-blocks

Compare these images

image
and
image

Notice the second URI isn't underlined and how hovering over it doesn't offer to open the file. The result is:
image

Options

  1. Leave the Markdown image as it is, and left-align the links to match
  2. Many other ReadMe files (in other repositories) use a very wide "hero image" that will almost always span the available/maximum width. If you want that, you'll have to make such an image first. Examples: WinUI Gallery, PowerToys, Files.
  3. Back to using HTML

Copy link
Owner

Choose a reason for hiding this comment

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

Let's currently go with 3 (I made additional few tweaks) for now. And will come back to 2. later once we have a fresh icon for hurl

This reverts commit 8af603c.
@U-C-S U-C-S merged commit 0b38373 into U-C-S:main Sep 11, 2024
@U-C-S
Copy link
Owner

U-C-S commented Sep 11, 2024

I merged your PR, if there's anything more you can open additional PRs. Thanks once again.

I will also take note of some discussion and things you mentioned

@Jay-o-Way Jay-o-Way deleted the docs-brush-up branch September 14, 2024 15:35
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.

2 participants