Skip to content
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.

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

FEATURE Extend docs #22

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

pixelbrackets
Copy link

@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