Skip to content

Commit

Permalink
Add more FAQs
Browse files Browse the repository at this point in the history
  • Loading branch information
hannalee2 committed Jun 28, 2024
1 parent 652efa1 commit 6eb7706
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/source/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@ FAQs
Reticle Detection
------------------------

.. _faq_r_0:

- Q. How should the reticle look in the view?

Here are some examples of how the reticle should look in the view:

.. image:: _static/reticleDetection.jpg
:scale: 20%

- Centered and in focus: The reticle should be well-centered in the view, with its center in clear focus.

- Properly illuminated: The reticle should be evenly lit without any harsh reflections or shadow regions.

- Appropriate size: The reticle should occupy a significant portion of the view, avoiding being too small or too large.

- Clear and unobstructed: The reticle surface should be clean, free of debris, dirt, or any obstructions, including probes, that could interfere with detection.

- Consistent background: The background should be plain and consistent, without any patterns or irregularities that might affect detection.

.. _faq_r_1:

- Q. Reticle is not detected. What should I do?
Expand Down
1 change: 1 addition & 0 deletions docs/source/ReadMe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Running Parallax

.. image:: _static/PathfinderHTTPServer.jpg
:alt: Enable HTTP server
:scale: 30%

2. **Run the Parallax application:**

Expand Down
3 changes: 3 additions & 0 deletions docs/source/userGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This page explains how to use the Parallax for basic functions, reticle calibrat

Reticle Calibration
--------------------

1. Click on the :blue:`Reticle Detection` button.

.. image:: _static/reticleDetection.jpg
Expand All @@ -36,6 +37,8 @@ Reticle Calibration

4. For more details, see the :ref:`FAQs <reticle_detection_faqs>`

- :ref:`Q. How should the reticle look in the view? <faq_r_0>`

- :ref:`Q. Reticle is not detected. What should I do? <faq_r_1>`

- :ref:`Q. Reprojection error is too high. How to fix it? <faq_r_2>`
Expand Down

0 comments on commit 6eb7706

Please sign in to comment.