Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tree view of the repository in README #36

Open
xfurna opened this issue Jul 28, 2019 · 5 comments
Open

Add tree view of the repository in README #36

xfurna opened this issue Jul 28, 2019 · 5 comments
Labels

Comments

@xfurna
Copy link
Contributor

xfurna commented Jul 28, 2019

Describe the bug/feature

It's quite a tedious job to open each folder in order to locate a file for some matter of consequence. It'd be better to add a tree view of the repository in the README itself from where we can simply pinpoint the file and just go for it.
To Reproduce(for bug)

It's a feature request (not for the website, but for a better contributor experience)

Screenshots(for bug)

No screenshot, but a tree view looks like this-

├── 404.html
├── assets
│   ├── css
│   │   ├── font-awesome.min.css
│   │   ├── main.scss
│   │   └── noscript.scss
│   ├── fonts
│   │   ├── FontAwesome.otf
│   │   ├── fontawesome-webfont.eot
│   │   ├── fontawesome-webfont.svg
│   │   ├── fontawesome-webfont.ttf
│   │   ├── fontawesome-webfont.woff
│   │   └── fontawesome-webfont.woff2
│   ├── icon
│   │   ├── android-chrome-192x192.png
│   │   ├── apple-touch-icon.png
│   │   ├── browserconfig.xml
│   │   ├── favicon-16x16.png
│   │   ├── favicon-32x32.png
│   │   ├── favicon.ico
│   │   ├── manifest.json
│   │   ├── mstile-150x150.png
│   │   └── safari-pinned-tab.svg
│   └── js
│       ├── jquery.min.js
│       ├── jquery.scrollex.min.js
│       ├── jquery.scrolly.min.js
│       ├── main.js
│       ├── skel.min.js
│       └── util.js
├── blog.md
├── _config.yml
├── Gemfile
├── Gemfile.lock
├── images
│   ├── benchmark-cpu-gpu.png
│   ├── bg.jpg
│   ├── overlay.png
│   ├── pic01.jpg
│   ├── pic02.jpg
│   ├── pic03.jpg
│   ├── pic04.jpg
│   ├── pic05.jpg
│   ├── pishing.png
│   └── wifi.png
├── _includes
│   ├── foot.html
│   ├── head.html
│   ├── nav.html
│   ├── scripts-main.html
│   └── tracking.html
├── index.html
├── ISSUE_TEMPLATE.md
├── _layouts
│   ├── blog.html
│   ├── page.html
│   └── post.html
├── LICENSE.md
├── _posts
│   ├── 2017-11-14-Dennis-Ritchie-Father-of-C.md
│   ├── 2017-11-14-Google-Lens-It's-Amazing!!!.md
│   ├── 2017-11-14-Link-Analysis-Why-Is-It-Important.md
│   ├── 2017-11-16-Humans-innovate-machines-calculate-Can-machines-think.md
│   ├── 2017-12-09-Brainfuck.md
│   ├── 2017-12-23-The-Man-Who-Knew-Infinity.md
│   ├── 2018-02-11-Tony-Stark.md
│   ├── 2018-02-13-The-Weirdest-Coincidence.md
│   ├── 2018-02-24-AUGMENTED-REALITY.md
│   ├── 2018-03-14-The-End-of-an-Era.md
│   ├── 2018-10-10-Ada-Lovelace-First-Computer-Programmer.md
│   ├── 2018-10-17-Paul-Allen.md
│   ├── 2019-05-26-Inception-Bar-A-new-type-of-phishing-attack.md
│   ├── 2019-05-30-CPU-GPU-and-TPU-in-Deep-Learning.md
│   ├── 2019-06-15-cplp.md
│   └── 2019-06-24-World-WiFi-Day.md
├── PULL_REQUEST_TEMPLATE.md
├── README.md
├── resources.md
├── _sass
│   ├── base
│   │   ├── _page.scss
│   │   └── _typography.scss
│   ├── components
│   │   ├── _box.scss
│   │   ├── _button.scss
│   │   ├── _form.scss
│   │   ├── _icon.scss
│   │   ├── _image.scss
│   │   ├── _list.scss
│   │   ├── _pagination.scss
│   │   ├── _section.scss
│   │   └── _table.scss
│   ├── layout
│   │   ├── _footer.scss
│   │   ├── _header.scss
│   │   ├── _intro.scss
│   │   ├── _main.scss
│   │   ├── _navPanel.scss
│   │   ├── _nav.scss
│   │   └── _wrapper.scss
│   └── libs
│       ├── _functions.scss
│       ├── _mixins.scss
│       ├── _skel.scss
│       └── _vars.scss
├── _site
│   ├── 404.html
│   ├── assets
│   │   ├── css
│   │   │   ├── font-awesome.min.css
│   │   │   ├── main.css
│   │   │   └── noscript.css
│   │   ├── fonts
│   │   │   ├── FontAwesome.otf
│   │   │   ├── fontawesome-webfont.eot
│   │   │   ├── fontawesome-webfont.svg
│   │   │   ├── fontawesome-webfont.ttf
│   │   │   ├── fontawesome-webfont.woff
│   │   │   └── fontawesome-webfont.woff2
│   │   ├── icon
│   │   │   ├── android-chrome-192x192.png
│   │   │   ├── apple-touch-icon.png
│   │   │   ├── browserconfig.xml
│   │   │   ├── favicon-16x16.png
│   │   │   ├── favicon-32x32.png
│   │   │   ├── favicon.ico
│   │   │   ├── manifest.json
│   │   │   ├── mstile-150x150.png
│   │   │   └── safari-pinned-tab.svg
│   │   └── js
│   │       ├── jquery.min.js
│   │       ├── jquery.scrollex.min.js
│   │       ├── jquery.scrolly.min.js
│   │       ├── main.js
│   │       ├── skel.min.js
│   │       └── util.js
│   ├── blog
│   │   ├── Ada-Lovelace-First-Computer-Programmer
│   │   │   └── index.html
│   │   ├── AUGMENTED-REALITY
│   │   │   └── index.html
│   │   ├── Brainfuck
│   │   │   └── index.html
│   │   ├── cplp
│   │   │   └── index.html
│   │   ├── CPU-GPU-and-TPU-in-Deep-Learning
│   │   │   └── index.html
│   │   ├── Dennis-Ritchie-Father-of-C
│   │   │   └── index.html
│   │   ├── Google-Lens-It's-Amazing!!!
│   │   │   └── index.html
│   │   ├── Humans-innovate-machines-calculate-Can-machines-think
│   │   │   └── index.html
│   │   ├── Inception-Bar-A-new-type-of-phishing-attack
│   │   │   └── index.html
│   │   ├── index.html
│   │   ├── Link-Analysis-Why-Is-It-Important
│   │   │   └── index.html
│   │   ├── page2
│   │   │   └── index.html
│   │   ├── page3
│   │   │   └── index.html
│   │   ├── Paul-Allen
│   │   │   └── index.html
│   │   ├── The-End-of-an-Era
│   │   │   └── index.html
│   │   ├── The-Man-Who-Knew-Infinity
│   │   │   └── index.html
│   │   ├── The-Weirdest-Coincidence
│   │   │   └── index.html
│   │   ├── Tony-Stark
│   │   │   └── index.html
│   │   └── World-WiFi-Day
│   │       └── index.html
│   ├── feed.xml
│   ├── feed.xslt.xml
│   ├── images
│   │   ├── benchmark-cpu-gpu.png
│   │   ├── bg.jpg
│   │   ├── overlay.png
│   │   ├── pic01.jpg
│   │   ├── pic02.jpg
│   │   ├── pic03.jpg
│   │   ├── pic04.jpg
│   │   ├── pic05.jpg
│   │   ├── pishing.png
│   │   └── wifi.png
│   ├── index.html
│   ├── ISSUE_TEMPLATE.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── resources
│   │   └── index.html
│   ├── sitemap.xml
│   └── thank-you
│       └── index.html
├── sitemap.xml
└── thank-you.md

42 directories, 155 files

Device Details(for bug)

Not a website issue.

Other Comments

@xfurna
Copy link
Contributor Author

xfurna commented Jul 28, 2019

I can push it if you allow. It's at my disposal.

@czgdp1807
Copy link
Member

Will it be dynamic, like the tree structure should change automatically whenever a new blog entry is added? Or in other words, it shouldn't be the case that REAMDE has to be updated every time a new file is added. AFAICT from https://stackoverflow.com/a/23990108, it isn't possible.
Well, if you are using an editor like, VSCode or Atom, they both show the directory structure in the EXPLORER section. So, it won't be of much use. Which editor are you using?

@czgdp1807
Copy link
Member

Please mention me whenever you create a new issue/PR. Sometimes a good issue can remain pending for a long time if left unnoticed.

@czgdp1807 czgdp1807 added question Further information is requested Workflow labels Aug 4, 2019
@xfurna
Copy link
Contributor Author

xfurna commented Aug 4, 2019

Will it be dynamic, like the tree structure should change automatically whenever a new blog entry is added? Or in other words, it shouldn't be the case that REAMDE has to be updated every time a new file is added.

I can write a script for editing README. How about that?

Which editor are you using?

Code.

CC: @czgdp1807

@czgdp1807
Copy link
Member

I can write a script for editing README. How about that?

Well, for now let's leave it but keep the issue open. We will come back to it at the time of developing the bot for the org.

@czgdp1807 czgdp1807 removed the question Further information is requested label Aug 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants