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

[UI] Docs explaining how to use the accordion component #200

Open
wants to merge 9 commits into
base: 5.x
Choose a base branch
from

Conversation

andersonjeccel
Copy link
Contributor

This PR introduces documentation for the accordion component, addressing a critical gap in our UI toolkit. Without this, developers would struggle to implement accordions consistently, leading to inconsistent user experiences and increased development time.

Here I provide instructions on how to properly utilize the accordion component, including best practices.

@favour-chibueze
Copy link
Contributor

@RCheesley Could you please help with this issue? I’ve fixed the Vale error, but it seems a link is breaking, which is causing the build to fail.

cc: @andersonjeccel

@RCheesley
Copy link
Member

@favour-chibueze it looks like https://docs.mautic.org/en/5.x/configuration/cron_jobs.html#tracking-script is no longer a valid link. This is because it was (rightly) moved out of the Cron Jobs section: https://docs.mautic.org/en/5.x/configuration/tracking_script.html.

So we need a separate PR to fix that build failure in the link file. Can you do that?

@favour-chibueze
Copy link
Contributor

@favour-chibueze it looks like https://docs.mautic.org/en/5.x/configuration/cron_jobs.html#tracking-script is no longer a valid link. This is because it was (rightly) moved out of the Cron Jobs section: https://docs.mautic.org/en/5.x/configuration/tracking_script.html.

So we need a separate PR to fix that build failure in the link file. Can you do that?

Here's the PR that fixes this

@RCheesley
Copy link
Member

Great, good to go then if you're happy with the PR changes @favour-chibueze and they render well. I haven't checked it yet myself.

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.

I have some concerns about two settings files which I think don't relate to this PR - can you take a look?

.vscode/settings.json Outdated Show resolved Hide resolved
.gitpod.yml Outdated Show resolved Hide resolved
@andersonjeccel
Copy link
Contributor Author

@RCheesley It seems RTC

@RCheesley
Copy link
Member

Please fix the heading nesting:

H1 ###
H2 ***
H3 ===
H4 ---
H5 ~~~

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.

The heading nesting is incorrect in this PR and it needs tweaking before it can be merged. Please see earlier comment.

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.

3 participants