simonw / simonw/research

your blog should point to the readme, not the folder

Open
#96 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
771
Forks
53
Avg merge
2m
Merged PRs (30d)
1

Description

Hello there,

I am a reader from your blog. One suggestion to improve your reader experience: the automated link to your experiment(s) subgolder from your blog should directly point to the readme, not the folder itself. The user would have a better experience that way (i think).

Have a great day/night (depending on your location)!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are mentioned. Locate the code that generates automated links from the blog to experiment folders, then inspect how those links are built. The work is done when each experiment link points directly to its README instead of the folder.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.