Improve the documentation and README

[yassinebenaid]

The current documentation is way too poor. The style is pretty awesome, But the content is not attractive at all. And so the README.md.

I hope someone with a good writing skills, To take a look at the documentation. And make the necessary changes to make it more attractive, more beneficial. And hopefully prettier if you have UI/UX skills.

Whoever is going to work on this, feel free to change the stack, the styling, content and anything else in the documentation. As long as it won't make it worse.

Currently, we use vitepress as a static site generator. The code is at /docs directory .

Make sure:

• the content is consistent
• The landing page gives the general overview. A good landing page provides description about what bunster is and why does it exist. A quick overview on the usage. Comparison with standard shells. And resources to learn more.
• Free of fake or misleading information.

If you have any questions regarding the project, you can write your questions in this thread.

Inspiration:

• https://amber-Lang.com.
• https://vuejs.org

Thanks 😊.

[yunz-dev]

This issue has been open for a while and I'd be happy to handle it. I've never done something like this but I'm happy to learn. Can't guarantee I'll be able to do it fast. What do you think @yassinebenaid

[yassinebenaid]

I would love to see your innovation. Thanks in advance @yunz-dev ❤️

[yassinebenaid]

Also, you don't have to bother your self with the styling because current style is good enough. what needs improvment is the landing page, needs to be attractive through examples and use cases etc. and the content is so poor, I write docs very fast due to lack of time, the language is so poor (also because I'm not english speaker). so it needs to be more beginner friendly.

Appretiated ❤️

[yunz-dev]

Yeah no worries I'll go through and try revamp it, (probably 1 page/section at a time so you can review it). A bit busy at the moment but I'll put it on my backlog and get through it all in one weekend hopefully.