| 29 May 2023 |
 @piegames:matrix.org | Difficult to put into words exactly why, but it rubs me the wrong way a bit. I think this folder should be documented extensively. And not only in the Nixpkgs manual, also in the contributing.md and honestly I think I'd even put a README.md into that folder that explains it | 11:04:41 |
 infinisil | Oh yeah I was just gonna say, the RFC should be changed to allow a readme in there, and ideally ensuring it gets ordered first (not sure if that's possible though) | 11:05:23 |
| @piegames:matrix.org | That's not really possible, especially given that most file viewers put "folders before files" | 11:06:17 |
| @piegames:matrix.org | Not sure to which extent this needs to be documented in the RFC vs being an "implementation detail" | 11:06:40 |
| infinisil | A folder called _WhatsThisDirectory containing a readme? :P | 11:06:44 |
| @piegames:matrix.org | IMO won't help | 11:07:02 |
| infinisil | Why not? It's the first thing you'll see when you look at that directory | 11:07:54 |
 Alyssa Ross | depends on how you're looking at it, no? | 11:08:08 |
| Alyssa Ross | i guess most stuff is either alphabetical or directories-first | 11:08:31 |
| @piegames:matrix.org | In GitHub? I'm pretty sure it groups folders before files too, so as the only file it would be the last entry no matter the name | 11:08:48 |
| infinisil | Alyssa Ross: Are you intending to reply in the thread? | 11:09:10 |
| Alyssa Ross | I have no idea | 11:09:14 |
| Alyssa Ross | because as I said, my client doesn't do threads | 11:09:23 |
| * @piegames:matrix.org regrets having started a thread | 11:09:37 |
| infinisil | In reply to @infinisil:matrix.org
A folder called _WhatsThisDirectory containing a readme? :P That's why I said it should be a directory, not a file :) | 11:09:54 |
| @piegames:matrix.org | Ooh | 11:10:15 |
| infinisil | Alright let's discuss here then | 11:10:18 |
| Alyssa Ross | Wouldn't GitHub display the content of the README for the directory though? | 11:10:21 |
| Alyssa Ross | It wouldn't if it was hidden in a subdirectory | 11:10:29 |
| @piegames:matrix.org | I have very mixed feelings about this | 11:10:34 |
| infinisil | I was suggesting to use a directory called _WhatsThisDirectory, which then contains a Readme.md file | 11:10:45 |
| infinisil | In reply to @qyliss:fairydust.space
Wouldn't GitHub display the content of the README for the directory though? Ah true, though wouldn't it be displayed only after all the subdirs are shown, which are like over 700? | 11:11:11 |
| @piegames:matrix.org | Maybe an empty folder called __SeeReadmeFirst? | 11:11:34 |
| @piegames:matrix.org | There is a button to collapse the file view, and I think the mobile view even does this by default | 11:12:23 |
| infinisil | I feel like we can just add a clause to the RFC stating that "The standard may be adjusted slightly in order to allow better documentation of it" | 11:12:27 |
| Alyssa Ross | I'm not thrilled about having to go to such lengths to compensate for GitHub's bad UI… | 11:12:40 |
| infinisil | We can also do multiple things, both a readme in the root, and a _WhatsThisDirectory directory | 11:13:21 |
| infinisil | Can't have too many entrypoints for documentation imo :) | 11:13:35 |
| Alyssa Ross | out of curiosity, if I do an actual reply, does it show up in the thread? | 11:13:59 |
| infinisil | Alyssa Ross: Nope | 11:14:12 |
