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

Convert About section to RST #245

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

RitaOC
Copy link
Contributor

@RitaOC RitaOC commented Oct 29, 2024

Worked on the conversion of the About section, including it's subsections.

@RitaOC
Copy link
Contributor Author

RitaOC commented Oct 31, 2024

Issue: #216

Kindly Review @RCheesley @fakela @favour-chibueze

@RCheesley RCheesley changed the title Rita_covert_abt Convert About section to RST Nov 4, 2024
@RCheesley
Copy link
Member

@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.

@RitaOC
Copy link
Contributor Author

RitaOC commented Nov 4, 2024

Thanks @RCheesley, I've worked on the heading kindly review.

Copy link
Member

@RCheesley RCheesley left a 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.

docs/about/how_can_i_try_mautic.rst Outdated Show resolved Hide resolved
docs/about/how_can_i_try_mautic.rst Outdated Show resolved Hide resolved
docs/about/about.rst Outdated Show resolved Hide resolved
docs/about/about.rst Outdated Show resolved Hide resolved
docs/about/how_can_i_try_mautic.rst Outdated Show resolved Hide resolved
docs/about/how_can_i_try_mautic.rst Outdated Show resolved Hide resolved
docs/about/how_is_mautic_used.rst Outdated Show resolved Hide resolved
docs/about/how_is_mautic_used.rst Outdated Show resolved Hide resolved
@RitaOC
Copy link
Contributor Author

RitaOC commented Nov 11, 2024

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.

@RCheesley please how can I go about this? Just using the heading syntax will that work?
H1

H2


H3

H4

H5


H6
^^^

@RCheesley
Copy link
Member

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants