Skip to content

Add description in index page#2

Draft
mmesiti wants to merge 3 commits intocoderefinery:mainfrom
mmesiti:description-in-index
Draft

Add description in index page#2
mmesiti wants to merge 3 commits intocoderefinery:mainfrom
mmesiti:description-in-index

Conversation

@mmesiti
Copy link

@mmesiti mmesiti commented Feb 10, 2026

Description should be adjusted - I have not put much thought into what to write there, I wanted just to explore how this is technically possible. For consistency, one could use the most appropriate of the already existing blobs of text.

Example: https://mmesiti.github.io/2026-03-17-workshop/

@samumantha
Copy link
Member

Since it will likely stay a short text, could we add it more directly, without separate html?

It's already quite a bunch of files to check and not always clear where content is actually located.


We could have it in shape/tone of a subtitle ?

"- Useful tools and techniques for researchers who code"?

Or something like that?

1 similar comment
@samumantha
Copy link
Member

Since it will likely stay a short text, could we add it more directly, without separate html?

It's already quite a bunch of files to check and not always clear where content is actually located.


We could have it in shape/tone of a subtitle ?

"- Useful tools and techniques for researchers who code"?

Or something like that?

@mmesiti
Copy link
Author

mmesiti commented Feb 10, 2026

Since it will likely stay a short text, could we add it more directly, without separate html?

It's already quite a bunch of files to check and not always clear where content is actually located.

I don't know why the decision was made to have so many files. In index.html for example there are a number of included files which are actually included only in index.html, so one could potentially just splice them where they are included. But if this was done in this way, perhaps there is a reason (separation of concerns?)

We could have it in shape/tone of a subtitle ?

"- Useful tools and techniques for researchers who code"?

Or something like that?

For sure!

@samumantha
Copy link
Member

Yea, there is likely a reason for that. Let's leave as separate files.

@samumantha
Copy link
Member

Any preference about the text?
You mentioned description should be adjusted in issue text, does that mean you did not like the one you had?

@samumantha
Copy link
Member

Could you add a screenshot on how your solution looks rendered, please?
Something is off with my setup :/

@mmesiti
Copy link
Author

mmesiti commented Feb 20, 2026

Could you add a screenshot on how your solution looks rendered, please? Something is off with my setup :/

Example: https://mmesiti.github.io/2026-03-17-workshop/

@mmesiti
Copy link
Author

mmesiti commented Feb 20, 2026

Any preference about the text? You mentioned description should be adjusted in issue text, does that mean you did not like the one you had?

I did not put much thought into it, that's all, as I do not feel I should take decisions on what is written so close to the title of a CodeRefinery workshop, since I'm just kind of a CodeRefinery hitchhiker/freeloader :-).

@mmesiti
Copy link
Author

mmesiti commented Feb 20, 2026

Yea, there is likely a reason for that. Let's leave as separate files.

Useless digression

From the log of the index.html file on the template repo, I can see that it was mostly @bast adding more include directives in the template, to keep the templates/ directory more modular, and that resonates very well with me as a programmer.
But if I were a layman person that just wants to change something in the workshop page (or just someone who is not familiar with the templates and and is doing this through the github web interface and CTRL+F is their only option) then every additional level of indirection would make things more complicated for me (until I learn how these templates work).

It's yet another instance of the flat vs nested, modular vs monolithic approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants