[DOCS] DPL-158: Streamline documentation - #53
Merged
Merged
Conversation
Align the DeepL Write documentation with the reworked
`web-vision/deepltranslate-core` and
`web-vision/deepltranslate-glossary` 6.x documentation.
* Rework the documentation index page introducing a card-grid
layout linking to the individual sections.
* Adopt the enhanced installation page (tabbed composer /
Extension Manager / TER instructions) and extend the version
support matrix, add an upgrade section (`Upgrade 1.x to 2.x`).
* Remove `Includes.rst.txt` and drop all include statements
referencing it.
* Introduce the Changelog section using `2.0` (`2`) as version,
documenting the removal of TYPO3 v12 support as breaking change
and the added TYPO3 v14 support as feature. The v14 feature
entry describes the handling and visual difference between
TYPO3 v13 and v14 localization, with accompanying screenshots.
* Extract the documentation rendering into a dedicated GitHub
workflow and let `runTests.sh -s renderDocumentation` fail on
rendering errors.
The documentation renders without errors or warnings using
`Build/Scripts/runTests.sh -s renderDocumentation`.
Documentation renderingYou can find files attached to the below linked Workflow Run URL (Logs). Please note that files only stay for around 5 days!
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Aligns the DeepL Write documentation with the reworked
web-vision/deepltranslate-coreandweb-vision/deepltranslate-glossary6.x documentation.
Changes
Index page — reworked with a
card-gridlayout linking to theindividual sections (Introduction, Administration, Reference, Known
Issues, Changelog), added intro text, license block and a hidden
Sitemap meta-menu.
Administration — adopted the enhanced installation page (tabbed
composer / Extension Manager / TER instructions), extended the version
support matrix and added an upgrade section (
Upgrade 1.x to 2.x).Removed
Includes.rst.txtand dropped all include statementsreferencing it.
Changelog section introduced using
2.0(2) as version:difference between TYPO3 v13 and v14 localization (v14
LocalizationHandlerInterfaceimplementation) with screenshots.Each changelog entry uses a unique
<type>-<unix-timestamp>anchor.Rendering workflow — extracted documentation rendering into a
dedicated GitHub workflow and let
runTests.sh -s renderDocumentationfail on rendering errors.Verification
The documentation renders without errors or warnings: