A lot of small fixes #78

Yusyuriv · 2024-03-09T01:26:28Z

Fix broken links, fix typos, rephrase complex sentences, fix incorrect markup, simplify markup

Yusyuriv · 2024-03-09T01:28:07Z

_coverpage.md

+<a href="https://www.flowlauncher.com/">
+    <img
+        width="250"
+        src="https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher@5ba4514f31e624c679628d4dfe89036c0e24006c/Doc/Logo/resources/flow-header-square-transparent.png"
+        alt="Flow Launcher logo"
+    >
+</a>


No need for <p>, it's centered by default. Also replaced the direct GitHub link with a jsDelivr one, like the docs recommend to do with plugin icons.

_sidebar.md

Yusyuriv · 2024-03-09T01:29:43Z

develop-dotnet-plugins.md

-2. A Dotnet Assembly that implements **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)** or **[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create  a `Main.cs` that implements `IPlugin`.
+To be recognized as a Flow DotNet plugin, the directory needs to have at least two files
+1. [`plugin.json`](/plugin.json.md)
+2. A Dotnet Assembly that implements **[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)** or **[IAsyncPlugin](/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create  a `Main.cs` that implements `IPlugin`.


Due to case-sensitivity, the links to the auto-generated docs were leading to 404.

Yusyuriv · 2024-03-09T01:42:48Z

how-to-create-a-theme.md

 (*There is a possibility of changing/deleting this part depending on the version.*)

-<img src="https://github.com/Flow-Launcher/docs/raw/main/assets/themelayout.png" style="zoom:50%;" />
+![Flow Launcher screenshot](https://cdn.jsdelivr.net/gh/Flow-Launcher/docs@main/assets/themelayout.png)


Replace the direct GitHub link with a jsDelivr one, like the docs recommend doing with plugin icons.

The CSS property zoom is non-standard and not supported in Firefox. The image looks just fine in full size.

how-to-create-a-theme.md

index.html

json-rpc.md

nodejs-plugin-references.md

testing.md

_coverpage.md

how-to-create-a-theme.md

index.html

nodejs-write-code.md

taooceros · 2024-03-09T03:43:19Z

py-setup-project.md

 ```

-5. The 'Install dependencies' section is where you will do most of your CI work. Notice it installs the requirements.txt and outputs it with the `-t` parameter to the `./lib` folder. This tells pip to dump all the installed modules to the local lib folder which you will zip up along with your project using the `zip -r Flow.Launcher.Plugin.HelloWorldPython.zip . -x '*.git*'`, where you replace this `Flow.Launcher.Plugin.HelloWorldPython` with the name of your plugin.
+5. The `Install dependencies` section is where you will do most of your CI work. Notice it installs the requirements.txt and outputs it with the `-t` parameter to the `./lib` folder. This tells pip to dump all the installed modules to the local lib folder which you will zip up along with your project using the `zip -r Flow.Launcher.Plugin.HelloWorldPython.zip . -x '*.git*'`, where you replace this `Flow.Launcher.Plugin.HelloWorldPython` with the name of your plugin.


I am a little bit skeptical using the code block for a section. Maybe bold or italic?

Maybe both? Or is it too much?

Is it possible to have a hyperlink actually?

It most likely is possible, it just doesn't make sense to use links because the sections they're describing are just below them:

Like a hashtag something? If click then the page just go directly to the section? I think that's common for docs.

I understand what you mean, I just don't understand why do this if the section it mentions is only 5 or 6 lines below the mention it self.

It refers to the section of the GitHub workflow file it describes, not a section of the page.

taooceros · 2024-03-09T03:43:44Z

py-setup-project.md


 ### 2. Publish as zip
-The final step to the workflow file is this publish section, which will publish the zip file you generated, upload to GitHub Releases page and tag with the version generated from the previous step from your plugin.json file. Remember again to replace `Flow.Launcher.Plugin.HelloWorldPython` with the name of your plugin.
+The final step to the workflow file is this `publish` section, which will publish the zip file you generated, upload to GitHub Releases page and tag with the version generated from the previous step from your plugin.json file. Remember again to replace `Flow.Launcher.Plugin.HelloWorldPython` with the name of your plugin.


py-write-code.md

usage-tips.md

Yusyuriv · 2024-03-09T05:35:58Z

I feel like there are too many places with phrasing like it's easy to do, just/simply do this. To me it sounds, I don't know... amateurish? unprofessional? The solution would be to remove the words just and simply from such sentences. A few examples:

When you are ready to release your plugin for people to enjoy, simply head over to Flow's plugin repo and follow the instructions there in the readme.

To back up your Flow's settings including installed plugins, simply back up your UserData folder. You can locate it quickly via querying flow launcher userdata.

Resetting Flow back to default settings is also easy, simply move/delete the UserData folder after closing the app, and the defaults will be recreated.

What do you think?

taooceros · 2024-03-09T07:01:33Z

I feel like there are too many places with phrasing like it's easy to do, just/simply do this. To me it sounds, I don't know... amateurish? unprofessional? The solution would be to remove the words just and simply from such sentences. A few examples:

When you are ready to release your plugin for people to enjoy, simply head over to Flow's plugin repo and follow the instructions there in the readme.

To back up your Flow's settings including installed plugins, simply back up your UserData folder. You can locate it quickly via querying flow launcher userdata.

Resetting Flow back to default settings is also easy, simply move/delete the UserData folder after closing the app, and the defaults will be recreated.

What do you think?

I didn't write those part but I agree with you. @Flow-Launcher/team what do others think about this?

z1nc0r3 · 2024-03-09T08:22:18Z

I agree with @Yusyuriv, it somewhat sounds unprofessional.
idk, maybe we can update like this:

To back up your Flow's settings including installed plugins, please back up your UserData folder. The UserData directory can be located using the query flow launcher userdata.

jjw24 · 2024-03-09T11:22:26Z

I feel like there are too many places with phrasing like it's easy to do, just/simply do this. To me it sounds, I don't know... amateurish? unprofessional? The solution would be to remove the words just and simply from such sentences. A few examples:

When you are ready to release your plugin for people to enjoy, simply head over to Flow's plugin repo and follow the instructions there in the readme.

To back up your Flow's settings including installed plugins, simply back up your UserData folder. You can locate it quickly via querying flow launcher userdata.

Resetting Flow back to default settings is also easy, simply move/delete the UserData folder after closing the app, and the defaults will be recreated.

What do you think?

Yeah remove them.

VictoriousRaptor · 2024-03-09T17:22:35Z

I feel like there are too many places with phrasing like it's easy to do, just/simply do this. To me it sounds, I don't know... amateurish? unprofessional? The solution would be to remove the words just and simply from such sentences. A few examples:

When you are ready to release your plugin for people to enjoy, simply head over to Flow's plugin repo and follow the instructions there in the readme.

To back up your Flow's settings including installed plugins, simply back up your UserData folder. You can locate it quickly via querying flow launcher userdata.

Resetting Flow back to default settings is also easy, simply move/delete the UserData folder after closing the app, and the defaults will be recreated.

What do you think?

These terms are more like oral expression rather than serious documents. It's fine to see them in less formal parts like FAQs IMO.

This reverts commit 7b77390.

onesounds · 2024-05-22T20:19:32Z

If there's nothing else to fix, just fix the conflict. I'll merge.

# Conflicts: # _sidebar.md # json-rpc-settings.md

A lot of small fixes

c91af45

Fix broken links, fix typos, rephrase complex sentences, fix incorrect markup, simplify markup