Rename files from `index.md` to `readme.md`

Open prashantrahul141 opened this issue 10 months ago • 3 comments

The lesson markdown files are currently named index.md, which means that when you open a lesson, you have to open the index.md file to start reading. If it were renamed to readme.md instead, GitHub would automatically detect it and display it right below the file section, just like it does in the root directory.

I can open a pr for this! Opened an issue instead, because I wanted to make sure it is something everyone wants.

Mar 24 '25 01:03 prashantrahul141

Great idea btw!

Mar 24 '25 05:03 Sahil12524

What if there were a table of contents in the README (plus cross-linking, i.e. "click here for the next lesson") instead?

Mar 24 '25 13:03 n0toose

@n0toose We could have both. A table of contents, cross linking in each lesson AND files being named readme.md.

Mar 25 '25 05:03 prashantrahul141