Quickstart¶

This guide will walk you through the process of adding your first manual/doc, which for examples sake, will be this documentation. This guide will also assume that you have a fresh install of the plugin, and have not changed any settings.

Opening the settings¶

To open up the settings website, type rtfm into flow launcher and press the Open Settings result.

Note

See Main Keyword for more information on that keyword.

_images/rtfm_result_example_darkmode.png

_images/rtfm_result_example_lightmode.png

Adding the doc¶

Find the Add Manual section, and input a keyword and location for the doc/manual. In our case, we will choose kw as the keyword, and rtfm.cibere.dev/latest as the location. Then press the Add button to add it.

Note

See Plugin Settings for more information on the plugin settings.

Editing the doc¶

To edit the manual/doc, scroll down until you find the doc/manual we just added. In our case, we are just going to leave it as-is.

Note

See the editing a manual section for information about the different fields.

Save the settings¶

Now we are going to save our settings so that it actually gets added to the plugin and so that we can query it. To save the settings, scroll up until you find the Plugin Settings section, and press the Save Settings & Reload Cache button.

Note

See the saving settings section for more information about saving the settings.

_images/save_settings_example_darkmode.png

_images/save_settings_example_lightmode.png

Querying the doc/manual¶

Now that we’ve added and saved our doc/manual, we can query it to see the results. As we set the keyword to kw in the adding the doc step, we will be using the kw keyword to do so. So, using flow, type kw presets and see the results.