signoz icon indicating copy to clipboard operation
signoz copied to clipboard

Revamping help center

Open GeekBoySupreme opened this issue 6 months ago • 2 comments

Our current help center redirects to a page and is used very rarely. This issue is meant to revamp the help center and make it more contextual and available to the users.

Outline of the new help center - opens in a side drawer and allows the user to access options to open full-fledged documentation, opening chat support (this would enable us to not to show the intercom chat widget all the time and keep the lower right corner of the screen blocked), also allowing links to Join community slack, open github, keyboard shortcuts etc.

https://github.com/user-attachments/assets/00007099-7601-497c-b666-5c03ce83fe69

We also want to enable docs search and exploration inside this help center. The prototype shows a bunch of links of suggested pages relevant for the screen in which the user has opened the side panel.

There are 2 ways we can implement this -

  • Maintain a map of page and links i.e. we maintain an internal mapping of relevant pages from the documentation. So when I am on the logs explorer and open Help and Support, we get to see pages relevant to logs explorer, and so on for traces, exceptions etc. In this scenario, we'd need to manually maintain this map and it wouldn't be easy to update/change these mappings without touching the frontend code.

  • The second approach is just to maintain the docs overview pages. For instance, Posthog has overview pages in docs for all their product modules. And the same overview page from docs gets rendered in an iframe (the docs page has been mobile optimized). This way docs remains the source of truth and we can keep updating the overview pages with different suggestions time and again without having to touch the frontend code.

GeekBoySupreme avatar Aug 21 '24 12:08 GeekBoySupreme