Skip to content

Commit

Permalink
CLI and web app roadmap.
Browse files Browse the repository at this point in the history
  • Loading branch information
lemon24 committed Jun 8, 2023
1 parent 4141d1f commit 949de4e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 11 deletions.
3 changes: 2 additions & 1 deletion docs/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ all browsers, including light-weight / text-only ones.

.. warning::

The web application is not stable yet and might change without any notice.
The web application is not fully supported,
see the :ref:`roadmap <app roadmap>` for details.

.. note::

Expand Down
7 changes: 5 additions & 2 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
Command-line interface
======================

This part of the documentation covers the *reader* command-line interface.
*reader* comes with a command-line interface
that exposes basic management functionality.


.. warning::

The CLI is not stable yet and might change without any notice.
The CLI is is not fully stable,
see the :ref:`roadmap <cli roadmap>` for details.

.. note::

Expand Down
37 changes: 29 additions & 8 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Development

Development should follow a problem-solution_ approach.

.. seealso:: :ref:`philosophy`
.. seealso:: :ref:`philosophy`

.. _problem-solution: https://hintjens.gitbooks.io/scalable-c/content/chapter1.html#problem-what-do-we-do-next

Expand All @@ -26,6 +26,7 @@ that makes it possible to build the feature on top.

Following is an unsorted, non-exhausive list of known areas for improvement.
I am working on *reader* based on my current interests,
in my spare time,
but I will prioritize supporting :doc:`contributors <contributing>`
(discussions, reviews and so on).

Expand Down Expand Up @@ -74,28 +75,48 @@ but I will prioritize supporting :doc:`contributors <contributing>`
* :ref:`feed categories <categories>`, likely as a plugin


Also see `open issues`_ and :ref:`Design notes`.
.. seealso::

`Open issues`_ and :ref:`Design notes`.

.. _open issues: https://github.com/lemon24/reader/issues


.. _cli roadmap:

Command-line interface
~~~~~~~~~~~~~~~~~~~~~~

* CLI stabilization.
The :doc:`cli` is more or less stable,\ [*]_
although both the output and config loading need more polish
and additional tests.

A full-blown terminal feed reader is *not* in scope,
since I don't need one,
but I'm not opposed to the idea.

.. [*] With the exception of ``serve``, which is provided by the web app.
.. _app roadmap:

Web application
~~~~~~~~~~~~~~~

.. The current web app is unsupported in that I don't have time to do any major changes/improvements to it. But, I am and will be using it until a better one exists.
The :doc:`app` is "unsupported",
in that it's not all that polished,
and I don't have time to do major improvments.
But, I am using it daily,
and it will keep working until a better one exists.

Long term, I'd like to:

.. I would like to have a more feature-complete web app at some point, one that actually looks nice and is pleasant to use by others. This seems like a bigger undertaking than I have time for (I do have ideas, though).
* re-design it from scratch to improve usability
* switch to `htmx`_ instead of using a home-grown solution
* spin it off into a separate package/project

.. by necessity, opinionated, so ideally it should be spun off in a separate project
.. _htmx: https://htmx.org/

* Web application re-design.
* Web application stabilization.


.. _compat:
Expand Down

0 comments on commit 949de4e

Please sign in to comment.