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

UX improvement label:documentation #15

Open
jacquesacc opened this issue Mar 19, 2023 · 1 comment
Open

UX improvement label:documentation #15

jacquesacc opened this issue Mar 19, 2023 · 1 comment

Comments

@jacquesacc
Copy link

In the selection list for the days, it would be great to add the name of the topic of the day.
Running quickly the whole thing for now, but I will most likely wantt o come back on certain pages later : having the name will help !

Also, at the bottom of the page, it could be more user friendly to add arrows to go to the previous/next page instead of having to scroll up.

@444B
Copy link

444B commented Jan 27, 2024

@jacquesacc I think this is a great idea!

Cause:
I have looked into it and currently the names pages are autogenerated in https://github.com/streamlit/30days/blob/master/streamlit_app.py with the following code on lines 15-25:

md_files = sorted(
    [int(x.strip("Day").strip(".md")) for x in glob.glob1("content", "*.md")]
)
# skipped lines
days_list = [f"Day {x}" for x in md_files]

The code creates the names by stripping it from the .md files in the content/ directory and only taking the Day and Number

Solution:

  1. We could either add the title to the names of the .md files in the content/ directory or
  2. We could strip the H1 / header of each file(which describes the page) and append it appropriately to md_files or days_list

Either of these would be a scalable long term solution
ill probably circle back to this when I have a moment

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

No branches or pull requests

2 participants