Updating layout suggestions

[lirantal]

Updating layout suggestions

[lzm0x219]

🎉

[lzm0x219]

The existing bug of gitlocalize can be circumvented by directly displaying the details. I think it is helpful to add TL;DR.

[lirantal]

Sounds good, I'll plan for both of these updates then 👌

[lzm0x219]

Great!👏

[lzm0x219]

Will you consider building a documentation website?

[lirantal]

I'm open to do that if someone wants to suggest pushing a docs directory for it and then we can also easily host it on GitHub Pages.

[lzm0x219]

Yeah, it's great! I've been working on a vuepress theme recently. what tools are you going to use?

[lirantal]

Didn't have anything in mind so whichever works and Vuepress is fine with me. Will it handle the current markdown style we have on the README though?

[lzm0x219]

It can be handled. Vuepress makes people focus on writing documents.

[lirantal]

Can you provide an example of a markdown type of README page and how does the vuepress visuals of it look like?

[lzm0x219]

This is the effect of the default theme：

example：https://vuepress.vuejs.org/
source：https://github.com/vuejs/vuepress/blob/master/packages/docs/docs/README.md

[lirantal]

If you can put up a quick example of how the README would look like that would be great. I was hoping for some kind of layout where the table of contents would be on the left, and the right would have the actual content and so navigation will be really easy.

[lzm0x219]

I am still developing such a theme, maybe https://v2.docusaurus.io/ is more suitable

[lirantal]

That's ok. Not super important and we'll get to it later on is just fine.

[lzm0x219]

👌

[lirantal]

@all-contributors please add @vvni for translation

[allcontributors]

@lirantal

I've put up a pull request to add @vvni! 🎉

[lirantal]

@all-contributors please add @terkelg @jasonkarns for content
@all-contributors please add @davesag for maintenance

[allcontributors]

@lirantal

I could not determine your intention.

Basic usage: @all-contributors please add @Someone for code, doc and infra

For other usages see the documentation

[lirantal]

@all-contributors please add @terkelg @jasonkarns for content

[allcontributors]

@lirantal

I've put up a pull request to add @terkelg! 🎉

[lirantal]

@all-contributors please add @jasonkarns for content

[allcontributors]

@lirantal

I've put up a pull request to add @jasonkarns! 🎉

[lirantal]

@all-contributors please add @davesag for maintenance

[allcontributors]

@lirantal

I've put up a pull request to add @davesag! 🎉

[lirantal]

I'll figure out the spacing later.
I think can close the issue for now