-
Notifications
You must be signed in to change notification settings - Fork 17
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
Add reST documentation #34
Comments
Gorgeous! Thank you :) |
The documentation (PR #40) is built upon the example manual provided by the t3docs team. Also, some good practices were copied from EXT:news docs. I added the contents of the README into the different sections. In order to match the other docs, I had to add or rewrite come content (see "Changes and additions"). The whole documentation was rendered successfully in a local environment. Changes and additions
Rendering on docs.typo3.orgIn order to get the new documentation rendered on docs.typo3.org, the following requirements must be met:
The new documentation adds a "Edit me on GitHub" button which allows users to quickly send PRs. If you don't want this, it can be easily removed. reST & Sphinx How-ToYou can find all necessary information about reStructuredText in the "How To document" section on docs.typo3.org. It also includes a handy Cheat Sheet. Additional notes"Configuration" main page only contains some text and a doctree. If you add a heading on this page, all sub pages of "Configuration" will be rendered as sub pages of this heading in the main navigation. That's just the way sphinx works. As a workaround, I added all sections as separate files. "TypoScript reference" is rendered with definition lists. Using the old Next stepsWhen this basic documentation is implemented, we can extend it with a new "FAQ" section inside "Configuration", e.g.:
|
Cool! When the new documentation is available on docs.typo3.org and up-to-date, I'd recommend to reduce the |
Thank you for preparing this so thoroughly and well-thought! I added the web hook and confirmed that https://intercept.typo3.com/admin/docs/deployments received a ping. |
I reduced README.md. I'll make issues for FAQ entries. |
A reStructuredText documentation on docs.typo3.org is the best way to introduce and explain the extension to users.
I will take care of this. The finished documentation will include the usual sections. The contents are taken from the current README file. I plan to extend it with a FAQ or Troubleshooting section; maybe in a later step.
The text was updated successfully, but these errors were encountered: