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.

Sign up for GitHub

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

Jump to bottom

Ambiguity between title.md and the title field in config file. #2318

Open
lyuanww opened this issue Mar 3, 2025 · 1 comment
Open

Ambiguity between title.md and the title field in config file. #2318

lyuanww opened this issue Mar 3, 2025 · 1 comment
Labels
a-Backend

Comments

@lyuanww
Copy link
Contributor

lyuanww commented Mar 3, 2025 •
edited
Loading

Currently, RepoSense has two features with similar names but different purposes: title.md provides an overview for the code analysis dashboard, while the title field in report-config.json (will be replaced by report-config.yaml) sets the browser page title. There is a naming overlap between the features.

Proposed solution

Renaming title.md
@damithc
Copy link
Collaborator

damithc commented Mar 3, 2025

How about we use title to mean the HTML header attribute <title> (this is what the title bar of the browser will show) and something like intro to refer to the description to put at the top of the page (which can include a heading etc.)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
a-Backend
Projects
RepoSense Roadmap
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@damithc @lyuanww