Skip to content

Conversation

@dabrt
Copy link
Contributor

@dabrt dabrt commented Oct 21, 2025

Question Answer
JIRA Ticket IBX-10163
Versions 4.6.x, 5.0.x
Edition LTS Update

Document integrated help

TODO:
Replace screenshots after fixes in product, describe ways to exit the help center once it is fixed in product.

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Added link to this PR in relevant JIRA ticket or code PR

@github-actions
Copy link

Preview of modified files

Preview of modified Markdown:

@AnnaKaih
Copy link

Preview of modified files

Preview of modified Markdown:

Notes:
⭕️ "If you are a developer whose task is to set up or extend the application, it links to developer documentation, API references and the GraphQL console." - should we add here that developer will have access to user documentation + dev docs? Highlighting that dev does not only have access to tech docs

⭕️ "Help center can be customized to fit the needs of your organization" - clickable link on the word "Customized" is not working

⭕️ If we agree to add X to close Help Center dialog, we need to say that to exit dialog click on the X

⭕️ I would also add that Help Center also shows the current version of the product ( meaning that a user may check the version from this place as well)

@dabrt
Copy link
Contributor Author

dabrt commented Oct 24, 2025

Notes: ⭕️ "If you are a developer whose task is to set up or extend the application, it links to developer documentation, API references and the GraphQL console." - should we add here that developer will have access to user documentation + dev docs? Highlighting that dev does not only have access to tech docs

Good point, I'll reword that statement.

⭕️ "Help center can be customized to fit the needs of your organization" - clickable link on the word "Customized" is not working

That's OK, the developer documenttion part is not merged yet. The links will start working when both PRs are merged.

⭕️ If we agree to add X to close Help Center dialog, we need to say that to exit dialog click on the X

Sure thing!

⭕️ I would also add that Help Center also shows the current version of the product ( meaning that a user may check the version from this place as well)

OK

@sonarqubecloud
Copy link

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