docs: updated documentation for Configuration component. #237
Conversation
There was a problem hiding this comment.
Hi there @Teebarh thanks for working on this.
There are a lot of Vale issues which need resolving.
Also, please ensure you fix the headings to use the correct length - they must be exactly the same as the text they underline.
Finally, please remove all links. You should be using the :doc: reference for linking to headings, or :ref: on the same page, or using the command make link for external links.
docs/plugins/config.rst
Outdated
| ============= | ||
|
|
||
| The form type is used to generate the form fields in the main configuration form. See the `Forms documentation <https://devdocs.mautic.org/en/latest/components/forms.html>`_ for more information about using form types. |
There was a problem hiding this comment.
| The form type is used to generate the form fields in the main configuration form. See the `Forms documentation <https://devdocs.mautic.org/en/latest/components/forms.html>`_ for more information about using form types. | |
| The form type is used to generate the fields in the main configuration form. See the `Forms documentation <https://devdocs.mautic.org/en/latest/components/forms.html>`_ for more information about using form types. |
Please also fix the link. See earlier comments.
Hi @RCheesley! I've made the changes in this commit here. |
There was a problem hiding this comment.
When this builds I noticed the route definitions table extends beyond the edge of the page, I think @favour-chibueze might know how to fix this? If so can we address it in this PR?
Otherwise it looks good, thanks @Teebarh for the work on this!
Thank you! It was a pleasure working on it. |
This pull request migrates over the documentation for the Configuration component in the reStructuredText (RST) format. It addresses Issue #60.