Include screenshot in UG for location of blurbs

[gekjunxu]

What feature(s) would you like to see in RepoSense

I think it would be good to include a screenshot which highlights where the blurbs specified in repo-blurbs.md, author-blurbs.md and chart-blurbs.md are located in a report.

Currently in the user guide there is screenshot on where an optional title would be rendered on the report, but not for the blurbs.

Moreover, currently, all blurbs are described in the same dotted list, which is a little hard to read. This could be separated into different sections to make it clearer to the user that chart blurbs, author blurbs, and repo blurbs refer to 3 different .md files in the config directory.

Is the feature request related to a problem?

I was working on #2432 but was initially confused on where chart blurbs would appear.

If possible, describe the solution

1. A screenshot with labels would help cut down troubleshooting time and allow new users to better understand the usage of blurbs, something like:

or

2. Separate the UG sections mentioning the blurbs.

If applicable, describe alternatives you've considered<!--

Let us know about other solutions you've tried or researched. --> I have considered using a screenshot for the frontend tests I was working on:

but I feel that using a report for tests on the user guide does not look that nice and/or does not demonstrate a good use for the blurbs. It might add more value to show an example of how repo-blurbs.md, author-blurbs.md and chart-blurbs.md may be useful, but I don't currently have an idea.

Perhaps might be good for discussion, and might be a good issue for first timers?

[CYX22222003]

I personally feel that it is a good issue for first timers. Thanks for contributing

@reposense/active-developers @reposense/active-reviewers-1 Any advice on this issue?

[sopa301]

I agree that it would be good to include screenshots for the User Guide.

Feel free to experiment around. One way I envision is to put 2 screenshots at the start to demonstrate the 3 ways of including blurbs at once (one ordered by authors, other ordered by repositories) with labelling. Another way is to put one screenshot for each section. But don't be limited by these approaches.

Also, could you kindly modify the issue to improve the formatting of the blurbs section as well? Currently all blurbs are described in the same dotted list, which is a little hard to read.