RepoSense icon indicating copy to clipboard operation
RepoSense copied to clipboard

Move title.md default location to configs folder

Open damithc opened this issue 1 year ago • 2 comments

As blurbs.md is located in configs folder, perhaps the default location of the title.md should follow the same?

damithc avatar May 14 '24 11:05 damithc

Currently, the title.md file does not need any processing by the backend before being transmitted to the frontend, hence it was placed in the assets folder. However, with the introduction of the one-stop config file in #2161, it may be beneficial to include the title in the generated summary.json and move title.md to the configs folder.

ckcherry23 avatar May 14 '24 12:05 ckcherry23

Currently, the title.md file does not need any processing by the backend before being transmitted to the frontend, hence it was placed in the assets folder. However, with the introduction of the one-stop config file in #2172, it may be beneficial to include the title in the generated summary.json and move title.md to the configs folder.

Also, the file location should make sense from the user point of view. For them, the configs folder is where they put their 'customizations'.

damithc avatar May 14 '24 13:05 damithc

@damithc @sopa301 It seems that currently the asset folder only contains favicon.ico and title.md. Should we move both of them to default configs file and remove the assets folder

CYX22222003 avatar Mar 10 '25 06:03 CYX22222003

Suggest to keep favicon.ico in assets folder as a dedicated space for static assets

joeng03 avatar Mar 10 '25 06:03 joeng03

How about putting the assets folder under the configs directory? As such, user does not need to use additional flag to specify the assets file. Otherwise, two copy actions need to be implemented to move favicon.ico from assets and title.md from configs separately.

CYX22222003 avatar Mar 10 '25 08:03 CYX22222003