Skip to content

[TASK] Add note about removing 1st line of guides.xml file. This first line currently leads to problems during intercept rendering of extension documentation #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sarahmccarthy123 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[TASK] Add note about removing 1st line of guides.xml file. This first line currently leads to problems during intercept rendering of extension documentation #525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Documentation/Howto/WritingDocForExtension/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ Follow the interactive dialog. We suggest to use the option ReStructuredText (rs
as this format provides the full power of the TYPO3 documentation theme. Using
Markdown (md) is an option for simple and quick one page documentation.

.. note::
The first line of the guides.xml file can lead to rendering problems on the
server, so it is best to delete it. The file should start with a `<guides`
tag and not an `<?xml` tag.

If your extension offers a main `Site set <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_
enter its name and path when prompted. This will regenerate ready to use
documentation about configuration for you. If you have more then one set you
Expand Down