Comments (4)
- 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!
from iscsc.fr.
i see a few ideas to do so:
- 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 theREADME
- keep track of the repo structure and notify with a script when the structure changes, not the content of the files
- the same but in a strutured file, like
TOML
orJSON
these are very not mature ideas, but what comes to me when reading your issue 😋
from iscsc.fr.
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!
from iscsc.fr.
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
orrg
- in the directories, i.e. the items ending in "
/
" in theREADME
, maybe aHEADER.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
orls
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 😉
from iscsc.fr.
Related Issues (20)
- Add containerization in development mode HOT 7
- Add proper logger and logging to the website HOT 4
- Ask for user confirmation on article deletion HOT 1
- Allow article to be set to `private` HOT 2
- Cannot access article creation page by url
- Add a mean to review and comment blog posts HOT 3
- make the README easier to read HOT 13
- Frontend upgrade for better design
- add a CI to check the format of the code HOT 3
- `author`, `contributors` fields in `package.json` HOT 1
- MongoDB container can't be reach and isn't persistent
- Refactor the website backend to a python `flask` backend HOT 1
- Security enhancement: use non-root containers for nginx/frontend/backend
- Import static images for blog post HOT 3
- Better design for the website HOT 4
- `npm run pretty` not supported on Windows
- Improve README instruction clarity HOT 7
- Add authentication middleware
- Implement an ArticleController
- Connect backend to MongoDB and fill routes endpoints HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from iscsc.fr.