Skip to content

Commit

Permalink
Update menu structure and add FAQs section with common questions and …
Browse files Browse the repository at this point in the history
…answers.
  • Loading branch information
forntoh committed Oct 1, 2024
1 parent b558038 commit 59f920d
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ including LCD displays and OLED displays *(coming soon)*.
reference/api/index
reference/uml
reference/migration/index
reference/faq
FAQs <reference/faq>
reference/acknowledgements
reference/feedback
reference/limitations
Expand Down
30 changes: 30 additions & 0 deletions docs/source/reference/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
|project| FAQ
=============

This is a list of Frequently Asked Questions about |project|. Feel free to suggest new entries!

.. dropdown:: How do I get started with |project|?
:animate: fade-in-slide-down

To get started with |project|, follow the steps in the :doc:`Getting Started guide </overview/getting-started>`.

.. dropdown:: How do I create a custom menu item?
:animate: fade-in-slide-down

To create a new menu item, you need to extend the base menu item class and implement the necessary methods.
Check the :doc:`API reference </reference/api/MenuItem>` for more information.

.. dropdown:: How do I update a menu item on runtime?
:animate: fade-in-slide-down

To update any attribute of a menu item on runtime, you need to call the appropriate setter method.

For example, to update the text of a basic menu item, you can call the :cpp:func:`MenuItem::setText` method.
Then call the :cpp:func:`LcdMenu::refresh` method to refresh the screen.

.. dropdown:: How do I hide the menu?
:animate: fade-in-slide-down

To hide the menu, you can call the :cpp:func:`LcdMenu::hide` method.
This will clear the screen and stop the menu from rendering.
To show the menu again, call the :cpp:func:`LcdMenu::show` method.

0 comments on commit 59f920d

Please sign in to comment.