Docs site

[madeleineostoja]

Describe the enhancement

Create a proper documentation site for Linaria, even just by putting current md docs into gitbook, for more legitimacy and community adoption.

Motivation

I'm advocating for Linaria in my agency, and the lack of a proper docs site is making that harder. The assortment of markdown files thrown in the github repo makes the project feel much less mature and fleshed out than it is, especially for wider adoption throughout the dev team compared to no-brainers like Emotion.

I also think how a project is perceived is really important for community adoption, especially when Atlassian's Compiled is maturing and has a beautiful, robust documentation site, but an (imo) less elegant API compared to the much more established Linaria.

Possible implementations

A proper site would be nice, but even just throwing the existing md files into a free gitbook project would be a drastic improvement. That's what I do for even my smallest side projects (eg: Pollen) since it's basically no more effort than just writing docs in github.

[Anber]

Hi @madeleineostoja!

The proper documentation is really important… but I just don't have time for it :(
I will really appreciate any help.

[madeleineostoja]

That’s fair! I’ll see if I can chuck up a gitbook site and transfer it to you when I have a mo.

Is Linaria in need of maintainers / is it still actively maintained?

[madeleineostoja]

Just to confirm if I whipped up a quick gitbook repo+site to transfer to you @Anber would you be open to making that the official docs for Linaria, moving the md docs from this repo to a docs repo? At least until somebody has time to build a custom site?

From an effort/results ratio I think thats the best move for the library atm. At least it gets docs out of scattered markdown files for new users. The only thing needed from you would be pointing docs.linaria.dev or similar to gitbook and changing the docs link on the existing splash page

Happy to do that this weekend if so

[Anber]

Hi @madeleineostoja
Sorry for the delay. I've applied for the community plan on GitBook. I'll let you know when it will be approved if you are still willing to help.

[hughrawlinson]

Hi!

I work at GitBook, and I've approved your application for the community plan. Please let me know if you have any questions about GitBook, or if I can help in any way!

Best,

Hugh from GitBook