[#2158] Add More Documentation for Title Component

reposense / RepoSense

Contribution analysis tool for Git repositories

https://reposense.org

MIT License

250 stars 153 forks source link

[#2158] Add More Documentation for Title Component #2159

Closed sopa301 closed 7 months ago

sopa301 commented 8 months ago

Fixes #2158.

Proposed commit message

Add More Documentation for Title Component

The documentation for the title component is sparse. Adding more
details on how to use it will make it easier for users to add their own
titles to their reports.

Let's update the documentation to include a section for the title
component, and add the title component to the default view.

Other information

Since the preview deployment uses the default build of the RepoSense report, all future builds will use the title component by default.

github-actions[bot] commented 7 months ago

The following links are for previewing this pull request:

Dashboard Preview: https://dashboard-2159-pr-reposense-reposense.surge.sh
Docs Preview: https://docs-2159-pr-reposense-reposense.surge.sh

damithc commented 6 months ago

Since the preview deployment uses the default build of the RepoSense report, all future builds will use the title component by default.

@sopa301 Does this mean all dashboard will have a default title.md? That shouldn't be the case, as that will force users to override the title.md, turning this opt-in feature into an opt-out feature.

sopa301 commented 6 months ago

Yes prof, I'll create a PR to remove it. If we still want the preview dashboard to have the title, I think we might need to create a separate config for the preview dashboard.

I think other opt-in features (e.g. blurbs) will also be able to be featured via this arrangement.