Skip to content

Commit c82102b

Browse files
PKuhlmayclaude
andcommitted
[BUGFIX] Fix #591: Rename test fixture User/ to Editor/ to match code template toctree
The previous commit changed the toctree entry from User/Index to Editor/Index but did not rename the corresponding test fixture directory, causing a mismatch. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 2b91afa commit c82102b

2 files changed

Lines changed: 50 additions & 68 deletions

File tree

  • Tests/Fixtures/TestExtensions/test_extension/Documentation.tmpl
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.. include:: /Includes.rst.txt
2+
3+
.. _for-editors:
4+
5+
===========
6+
For Editors
7+
===========
8+
9+
How to use the extension from the perspective of an editor.
10+
11+
Think of common tasks that an editor is likely to perform:
12+
13+
- How do they complete them?
14+
- What problems are they likely to encounter?
15+
- What access do they require?
16+
- What configuration options are available to them?
17+
18+
One example could be adding a frontend plugin to a page and then configuring it.
19+
20+
Language should be non-technical, aim to avoid using acronyms where possible.
21+
22+
Be mindful that editors typically don't have administrative access to the installation.
23+
24+
.. tip::
25+
26+
Take a break from time to time.
27+
28+
Admonitions should be used to warn the users about potential pitfalls.
29+
Attract their attention to important elements,
30+
or add some notes for for information (further reading, for example).
31+
32+
Do not overuse admonitions like notes, important, etc.!
33+
34+
Provide screenshots as needed for making things clear.
35+
When creating screenshots, try using the Official Introduction Package.
36+
37+
.. figure:: ../Images/UserManual/BackendView.png
38+
:class: with-shadow
39+
:alt: Backend view
40+
41+
Default Backend view (caption of the image)
42+
43+
Do not use huge full-screen images, unless it is necessary and serves a good purpose.
44+
45+
.. _editor-faq:
46+
47+
FAQ
48+
===
49+
50+
Possible subsection: FAQ

Tests/Fixtures/TestExtensions/test_extension/Documentation.tmpl/User/Index.rst

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)