Skip to content

Commit 9bd312f

Browse files
committed
update docs
1 parent 4f42ab9 commit 9bd312f

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/changelog.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
Changelog
22
=========
33

4-
- Rewrite preset system, so that the parsers are contained in a different repository, and they are loaded via a doctype.
4+
- Remove the preset system, so that the parsers are contained in a different repository, and they are loaded via a doctype.
55
- This will allow for faster and automatic preset updates, faster caching times, and it will reduce the strain on the hosts.
66
- Remove the ``Use Cache`` option for non-api presets/doctypes.
77
- Add a ``Cache Results`` option for doctype entries
8-
- Rewrite settings to reduce code duplication and to stop dumping settings about 5 times every time the save button in the webserver is clicked
8+
- Rewrite settings to reduce code duplication and to stop dumping settings about 5 times every time the save button in the webserver is clicked
9+
- Strip the plugin's core (~1.5k lines removed) and move them to their own repository so that they can be integrated in other places
10+
- Fix a bug with certain error icons not showing

docs/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
rtfm plugin
22
===========
3-
The rtfm plugin for `flow launcher <https://www.flowlauncher.com/>`__ makes it easy to query docs or manuals.
3+
The rtfm plugin for `flow launcher <https://www.flowlauncher.com/>`__ makes it easy to query docs or manuals. The plugin is a wrapper over the `rtfm lookup <https://github.com/cibere/rtfm-lookup>`__ python library from the same author, with a `rtfm indexes <https://github.com/cibere/Rtfm-Indexes/>`__ repository for manuals/docs that don't conform to any standard.
44

55
For a list of versions that documentation is available for, see `here <https://rtfm.cibere.dev>`__.
66

7+
.. NOTE::
8+
Is there a manual/doc that isn't being indexed? You can create an issue on any of the following repositories to request it: `rtfm plugin <https://github.com/cibere/Flow.Launcher.Plugin.rtfm>`__, `rtfm indexes <https://github.com/cibere/Rtfm-Indexes/>`__, `rtfm lookup <https://github.com/cibere/rtfm-lookup>`__
9+
710
Getting Help
811
-------------
912
Need help? Either create an `issue request on github <https://github.com/cibere/Flow.Launcher.Plugin.rtfm/issues/new>`__, or join the `official flow discord server <https://discord.gg/QDbDfUJaGH>`__ and ask there.

0 commit comments

Comments
 (0)