bun icon indicating copy to clipboard operation
bun copied to clipboard

Separate README into documentation pages

Open leap0x7b opened this issue 3 years ago • 1 comments

Affected URL(s)

No response

Description of the problem

Putting the entire documentation in the README makes it more cluttered, it's probably best to separate them into pages.

leap0x7b avatar Jul 25 '22 02:07 leap0x7b

Hey @Jarred-Sumner :wave: Can I help you to separate the documentation into pages and structure it? I would like to get involved in the project and I think documentation is a good first step for me - to help you and to learn more.

We can for example start with separating the chapters under the "Table of contents" to their own folder and files.

I see there already is a docs folder in the repository do you have any idea where to put the files or how to structure it? It looks to me the files inside the docs directory are not related to the documentation for users (README). But maybe I am wrong.

stefanprokopdev avatar Sep 15 '22 18:09 stefanprokopdev

Hi there , Please assign it to me

sanyamgandhak avatar Oct 07 '22 19:10 sanyamgandhak

We've started to work on the official documentation, it will be moved out of the README and onto a proper website. Stay tuned! 👀

Electroid avatar Nov 03 '22 00:11 Electroid