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

Move title.md default location to configs folder #2205

Open
damithc opened this issue May 14, 2024 · 5 comments · May be fixed by #2315
Open

Move title.md default location to configs folder #2205

damithc opened this issue May 14, 2024 · 5 comments · May be fixed by #2315

Comments

@damithc
Copy link
Collaborator

damithc commented May 14, 2024

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

@ckcherry23
Copy link
Member

ckcherry23 commented May 14, 2024

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.

@damithc
Copy link
Collaborator Author

damithc commented May 14, 2024

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'.

@joeng03 joeng03 self-assigned this Mar 3, 2025
@CYX22222003 CYX22222003 linked a pull request Mar 3, 2025 that will close this issue
@CYX22222003
Copy link
Contributor

@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

@joeng03
Copy link
Contributor

joeng03 commented Mar 10, 2025

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

@CYX22222003
Copy link
Contributor

CYX22222003 commented Mar 10, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

5 participants