Skip to content

Commit d0a2a9a

Browse files
EeemsEeems
authored
Merge pull request #17 from toltec-dev/faq_links
Add anchors to faqs, update python, use static sidebar due to limitat…
2 parents 1809760 + 3d1f9bb commit d0a2a9a

File tree

6 files changed

+106
-77
lines changed

6 files changed

+106
-77
lines changed

‎.github/workflows/publish.yml‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
11
name: publish
22
on:
3-
push:
4-
branches:
5-
- main
6-
repository_dispatch:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
branches:
8+
- "*"
9+
repository_dispatch:
710
jobs:
8-
publish:
9-
name: Build and publish the website
10-
runs-on: ubuntu-20.04
11-
steps:
12-
- name: Checkout the Git repository
13-
uses: actions/checkout@v2
14-
- name: Setup Python
15-
uses: actions/setup-python@v2
16-
with:
17-
python-version: '3.8'
18-
- name: Build website
19-
run: make prod
20-
- name: Sync website with the remote repository
21-
uses: ./.github/actions/sync-repository
22-
with:
23-
local-path: dist/
24-
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
25-
ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
26-
ssh-port: ${{ secrets.SSH_PORT }}
27-
remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
11+
publish:
12+
name: Build and publish the website
13+
runs-on: ubuntu-24.04
14+
steps:
15+
- name: Checkout the Git repository
16+
uses: actions/checkout@v2
17+
- name: Setup Python
18+
uses: actions/setup-python@v2
19+
with:
20+
python-version: "3.13"
21+
- name: Build website
22+
run: make prod
23+
- name: Sync website with the remote repository
24+
if: ${{ github.ref == 'refs/heads/main' }}
25+
uses: ./.github/actions/sync-repository
26+
with:
27+
local-path: dist/
28+
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
29+
ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
30+
ssh-port: ${{ secrets.SSH_PORT }}
31+
remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

‎requirements.txt‎

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
1-
alabaster==0.7.12
2-
Babel==2.9.1
3-
certifi==2021.10.8
4-
charset-normalizer==2.0.7
5-
colorama==0.4.4
6-
docutils==0.17.1
7-
idna==3.3
8-
imagesize==1.2.0
9-
Jinja2==3.0.2
10-
livereload==2.6.3
11-
MarkupSafe==2.0.1
12-
packaging==21.0
13-
Pygments==2.10.0
14-
pyparsing==2.4.7
15-
pytz==2021.3
16-
requests==2.26.0
17-
six==1.16.0
18-
snowballstemmer==2.1.0
19-
Sphinx==4.2.0
20-
sphinx-autobuild==2021.3.14
21-
sphinxcontrib-applehelp==1.0.2
22-
sphinxcontrib-devhelp==1.0.2
1+
Sphinx==8.0.2
2+
sphinx-autobuild==2024.9.19
233
sphinxcontrib-fulltoc==1.2.0
24-
sphinxcontrib-htmlhelp==2.0.0
4+
sphinxcontrib-htmlhelp==2.1.0
255
sphinxcontrib-jsmath==1.0.1
26-
sphinxcontrib-qthelp==1.0.3
27-
sphinxcontrib-serializinghtml==1.1.5
28-
tornado==6.1
29-
urllib3==1.26.7

‎src/_ext/__pycache__/bootstrap.cpython-313.pyc‎

2.43 KB
Binary file not shown.

‎src/_themes/toltec/nav.html‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
<nav class="sidebar-nav">
2-
{{ toc }}
2+
<ul class="current">
3+
<li class="toctree-l1"><a class="reference internal" href="#install-toltec">
4+
Install Toltec
5+
</a></li>
6+
<li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
7+
What Does Toltec
8+
Do?
9+
</a></li>
10+
<li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
11+
Frequently Asked Questions
12+
</a>
13+
</li>
14+
<li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
15+
Packages
16+
</a></li>
17+
<li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
18+
Entware Packages
19+
</a></li>
20+
<li class="toctree-l1"><a class="reference external"
21+
href="https://github.com/toltec-dev/toltec/releases/latest">
22+
Latest Release Notes
23+
</a></li>
24+
</ul>
325
</nav>

‎src/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
html_title = "Toltec"
1515
html_theme = "toltec"
1616
master_doc = "sitemap"
17-
html_sidebars = { "**": ["nav.html", "sidefooter.html"] }
17+
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
1818
html_permalinks_icon = "#"
1919

2020
extensions = [

‎src/index.rst‎

Lines changed: 51 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -86,50 +86,77 @@ Frequently Asked Questions
8686
==========================
8787

8888
Where can I get help?
89-
If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
90-
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
89+
---------------------
90+
91+
If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
92+
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
9193

9294
Is this supported by reMarkable AS?
93-
No, this is a community project.
95+
-----------------------------------
96+
97+
No, this is a community project.
9498

9599
Will this brick my reMarkable?
96-
Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
100+
------------------------------
101+
102+
Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
97103

98104
Do you support reMarkable 2?
99-
Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
105+
---------------------------------
106+
107+
Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
108+
109+
Do you support reMarkable Paper Pro or Move?
110+
--------------------------------------------
111+
112+
Not at this time.
100113

101114
Why doesn't toltec support the latest OS version as soon as it comes out?
102-
Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
115+
-------------------------------------------------------------------------
116+
117+
Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
103118

104119
Can I add `__________` to Toltec?
105-
We’re always open to adding new packages to the repository.
106-
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
120+
---------------------------------
121+
122+
We’re always open to adding new packages to the repository.
123+
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
107124

108125
I found a vulnerability in Toltec or one of its packages, where can I report it?
109-
To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
126+
-------------------------------------------------------------------------------------
127+
128+
To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
110129

111130
Can I factory reset my reMarkable if I have toltec installed?
112-
No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
131+
-------------------------------------------------------------
132+
133+
No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.
113134

114135
Why can't I install toltec before my OS is supported?
115-
`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
136+
-----------------------------------------------------
137+
138+
`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
116139

117140
Why doesn’t toltec support the beta OS versions?
118-
`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
141+
------------------------------------------------
142+
143+
`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
119144

120145
My reMarkable seems to have become unresponsive, how do I fix it?
121-
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
146+
-----------------------------------------------------------------
122147

123-
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
124-
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.
125-
126-
If you can SSH in through USB, the following may work:
148+
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
127149

128-
.. parsed-literal::
150+
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
151+
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.
152+
153+
If you can SSH in through USB, the following may work:
154+
155+
.. parsed-literal::
129156
130-
rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
131-
systemctl unmask sync.service || systemctl unmask rm-sync.service
132-
systemctl disable --now manual-sync.service
133-
systemctl daemon-reload
134-
systemctl reset-failed xochitl
135-
systemctl restart xochitl
157+
rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
158+
systemctl unmask sync.service || systemctl unmask rm-sync.service
159+
systemctl disable --now manual-sync.service
160+
systemctl daemon-reload
161+
systemctl reset-failed xochitl
162+
systemctl restart xochitl

0 commit comments

Comments
 (0)