Automating updates of the repo structure

[atxr]

As you know, we keep track of the repo structure in the README, and it's a very useful feature for new developers on this project!
However, it's very boring to update it by hand at each PR.
I don't see any solution but I'm sure we can do something about this. At least but an alert or a github action that remind us to do it at each PR!

[amtoine]

i see a few ideas to do so:

1. add headers to the files and directories to be in the structure summary, each header would contain the description in the README and then parse them and the whole repo to generate the new structure in the README
2. keep track of the repo structure and notify with a script when the structure changes, not the content of the files
3. the same but in a strutured file, like TOML or JSON

these are very not mature ideas, but what comes to me when reading your issue 😋

[ctmbl]

I was going to propose something slightly less complete than @amtoine but I like this "header" idea, however, how do you add a header to a directory ??

A simple github action that parses the README and compare it to tree or ls on the repo should do the job I think! That looks like quite some thinking and work but doesn't seems impossible!

[amtoine]

I was going to propose something slightly less complete than @amtoine but I like this "header" idea, however, how do you add a header to a directory ??

well 🤔

• in the files: a simple header with a string easy to grep or rg
• in the directories, i.e. the items ending in "/" in the README, maybe a HEADER.txt or .header.txt file could do the trick
  something in that vein 😋

A simple github action that parses the README and compare it to tree or ls on the repo should do the job I think! That looks like quite some thinking and work but doesn't seems impossible!

definitely something that could be usefull 👍
but that does not solve the issue with the descriptions 🤔
see above 😉

[ctmbl]

• in the files: a simple header with a string easy to grep or rg
• in the directories, i.e. the items ending in "/" in the README, maybe a HEADER.txt or .header.txt file could do the trick
  something in that vein

I like that!