Docs brush up - Githubissues

U-C-S / Hurl

Choose the browser on the click of a link

MIT License

294 stars 10 forks source link

Closed Jay-o-Way closed 2 months ago

Jay-o-Way commented 2 months ago

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: https://github.com/U-C-S/Hurl/blob/7c2d07be6bddc1f07c4222f9acc82a0904bd1bbf/Docs/Edit-UserSettingsjson.md?plain=1#L98
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?

U-C-S commented 2 months ago

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 commented 2 months ago

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

U-C-S commented 2 months ago

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

U-C-S commented 2 months ago

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