Skip to content

Commit 527ce27

Browse files
chore(docs): add faq page (#418)
* chore(docs): add faq page Closes #405 * chore(docs): add faq page Closes #405 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update changelog * fix --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 04bca45 commit 527ce27

File tree

4 files changed

+55
-25
lines changed

4 files changed

+55
-25
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515

1616
- Added CI for broken HTML links and fixed, plus spell checking.
1717
[#417](https://github.com/jeertmans/manim-slides/pull/417)
18+
- Create FAQ page and clear FAQ from README.md
19+
[#418](https://github.com/jeertmans/manim-slides/pull/418)
1820

1921

2022
(v5.1.4)=

README.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ Manim Slides will *automatically* detect the one you are using!
2828
- [Installation](#installation)
2929
- [Usage](#usage)
3030
- [Comparison with Similar Tools](#comparison-with-similar-tools)
31-
- [F.A.Q](#faq)
32-
* [How to increase quality on Windows](#how-to-increase-quality-on-windows)
31+
- [F.A.Q](https://eertmans.be/manim-slides/latest/faq.html)
3332
- [Contributing](#contributing)
3433
* [Reporting an Issue](#reporting-an-issue)
3534
* [Seeking for Help](#seeking-for-help)
@@ -150,23 +149,6 @@ Below is a comparison of the most used ones with Manim Slides:
150149
| Web Browser presentations | Yes | No | Yes | No |
151150
| Offline presentations | Yes, with Qt | Yes, with OpenCV | No | No
152151

153-
## F.A.Q
154-
155-
### How to increase quality on Windows
156-
157-
On Windows platform, one may encounter a lower image resolution than expected.
158-
Usually, this is observed because Windows rescales every application to
159-
fit the screen.
160-
As found by [@arashash](https://github.com/arashash),
161-
in [#20](https://github.com/jeertmans/manim-slides/issues/20),
162-
the problem can be addressed by changing the scaling factor to 100%:
163-
164-
<p align="center">
165-
<img alt="Windows Fix Scaling" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/windows_quality_fix.png">
166-
</p>
167-
168-
in *Settings*->*Display*.
169-
170152
## Contributing
171153

172154
Contributions are more than welcome! Please read through
@@ -202,12 +184,10 @@ be able to help you!
202184
Sometimes, you may have a question about Manim Slides,
203185
not necessarily an issue.
204186

205-
There are two ways you can reach us for questions:
206-
207-
- via the `Question/Help/Support` topic when
208-
[choosing an issue template](https://github.com/jeertmans/manim-slides/issues/new/choose);
209-
- or via
210-
[GitHub discussions](https://github.com/jeertmans/manim-slides/discussions).
187+
First, make sure to read the
188+
[F.A.Q](https://eertmans.be/manim-slides/latest/faq.html) to see if
189+
your question has already been answered. If not, please follow the
190+
recommendation (from that page) to reach us for questions.
211191

212192
<!-- end seeking-for-help -->
213193

docs/source/faq.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Frequently Asked Questions
2+
3+
This page summarizes a few of the most frequently asked questions
4+
when using Manim Slides.
5+
6+
They are organized by topic.
7+
8+
If your question is not here, please first look through the
9+
[open **and closed** issues on GitHub](https://github.com/jeertmans/manim-slides/issues?q=is%3Aissue)
10+
or within the [discussions](https://github.com/jeertmans/manim-slides/discussions).
11+
12+
If you still cannot find help after that, do not hesitate to create
13+
your own issue or discussion on GitHub!
14+
15+
## Installing
16+
17+
Everything related to installing Manim-Slides.
18+
19+
Please do not forget the carefully read through
20+
the ... page!
21+
22+
###
23+
24+
## Rendering
25+
26+
##
27+
28+
### Presenting
29+
30+
31+
32+
## F.A.Q
33+
34+
### How to increase quality on Windows
35+
36+
On Windows platform, one may encounter a lower image resolution than expected.
37+
Usually, this is observed because Windows rescales every application to
38+
fit the screen.
39+
As found by [@arashash](https://github.com/arashash),
40+
in [#20](https://github.com/jeertmans/manim-slides/issues/20),
41+
the problem can be addressed by changing the scaling factor to 100%:
42+
43+
<p align="center">
44+
<img alt="Windows Fix Scaling" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/windows_quality_fix.png">
45+
</p>
46+
47+
in *Settings*->*Display*.

docs/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ installation
4343
reference/index
4444
features_table
4545
manim_or_manimgl
46+
faq
4647
```
4748

4849
```{toctree}

0 commit comments

Comments
 (0)