Electron Documentation `README` is inaccurately titled FAQ

Open vanessayuenn opened this issue 8 years ago • 2 comments

https://electronjs.org/docs/README

Dec 22 '17 11:12 vanessayuenn

👋 Thanks for opening your first issue here!

Dec 22 '17 11:12 welcome[bot]

Thanks for creating this issue. I didn't know that the README was making it through to the website. Does anything link to this?

My hope is that this file (/docs/README/md in the electron/electron repo) will eventually get a big overhaul, with a more thorough table of contents. Then it will be the responsibility of electron-i18n's build process to parse the README's new TOC and use it to build a sidebar, [next] and [previous] links, etc on the website. The actual file /doc/README should ultimately not be rendered on the site.

See https://github.com/electron/electron/issues/11416

Dec 22 '17 19:12 zeke