Skip to content

FEATURE Extend docs#22

Open
pixelbrackets wants to merge 4 commits intotdeuling:masterfrom
webit-de:20180227-docs-explain-module
Open

FEATURE Extend docs#22
pixelbrackets wants to merge 4 commits intotdeuling:masterfrom
webit-de:20180227-docs-explain-module

Conversation

@pixelbrackets
Copy link
Copy Markdown

@pixelbrackets pixelbrackets commented Feb 27, 2018

  • Better readability (Add some spaces etc)
  • Add some more examples for beginners
  • Explain importance of module key & tour identifier
  • Explain YAML format

Preview: https://github.com/webit-de/typo3-guide/blob/20180227-docs-explain-module/Readme.md

Explain why it is important to set a valid module key.

Explain that the tour identifier is used for filenames (YAML)
and Configuration (TSConfig overwrites) as well.
Restore note about how to add Page-TSconfig since the
guide extension reads Page-TSconfig from root page only,
and not subpages →requires PHPP.
Add some spaces, shorten some sentences.

Add some explainations for beginners.
Configuration explained in Readme already,
dont maintain two docs at once (one of both will always be too old).
@pixelbrackets pixelbrackets changed the title Extend docs Feature Extend docs Feb 27, 2018
@pixelbrackets pixelbrackets changed the title Feature Extend docs FEATURE Extend docs Feb 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant