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

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

Merged
merged 20 commits into from
Apr 18, 2024

Conversation

sopa301
Copy link
Contributor

@sopa301 sopa301 commented Mar 16, 2024

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.

@sopa301 sopa301 requested a review from a team March 20, 2024 15:18
@sopa301 sopa301 marked this pull request as ready for review March 20, 2024 15:18
Copy link
Contributor

@asdfghjkxd asdfghjkxd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sopa301 sopa301 requested a review from a team March 27, 2024 16:46
docs/ug/customizingReports.md Outdated Show resolved Hide resolved
docs/ug/customizingReports.md Outdated Show resolved Hide resolved
docs/ug/customizingReports.md Outdated Show resolved Hide resolved
docs/ug/customizingReports.md Outdated Show resolved Hide resolved
@sopa301 sopa301 requested a review from ckcherry23 March 28, 2024 14:48
Copy link
Member

@ckcherry23 ckcherry23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ckcherry23 ckcherry23 requested a review from a team March 28, 2024 20:20
Copy link
Contributor

@vvidday vvidday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ckcherry23 ckcherry23 merged commit 4cceaea into reposense:master Apr 18, 2024
8 checks passed
Copy link
Contributor

The following links are for previewing this pull request:

@damithc
Copy link
Collaborator

damithc commented May 14, 2024

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
Copy link
Contributor Author

sopa301 commented May 14, 2024

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.

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.

Add More Documentation for Title Component
5 participants