-
-
Notifications
You must be signed in to change notification settings - Fork 30
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
Convert About section to RST #245
base: main
Are you sure you want to change the base?
Conversation
Issue: #216 Kindly Review @RCheesley @fakela @favour-chibueze |
@RitaOC please can you address the headings using the wrong nesting? I just wrote up some docs which you can review here: https://github.com/mautic/mautic-community-handbook/pull/242/files#diff-479d15272f6690640302496b1f2a15541a9a8ce28b7e5c68c2a8bd6063fe2551 which contains all the details you should need to address this. |
Thanks @RCheesley, I've worked on the heading kindly review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this @RitaOC - I think perhaps this would sit better as one single file - About - which has all of the content as subheadings? The beauty of our RST/Sphinx/RTD setup is that these subheadings are all nested underneath each other on the menu, so it will work pretty nicely I think.
Co-authored-by: Ruth Cheesley <[email protected]>
@RCheesley please how can I go about this? Just using the heading syntax will that work? H2 H3H4H5
|
@RitaOC yes that's right - the navigation on the menu is controlled by the nesting of the headings. So if we bring everything into one file, and nest the headings correctly, I think that'll be easier for people to explore/navigate and it's easier for us to maintain, too! |
Worked on the conversion of the About section, including it's subsections.