website icon indicating copy to clipboard operation
website copied to clipboard

[docs/jotai] create a dedicated introduction page

Open dai-shi opened this issue 4 years ago • 4 comments

For now, #43 and #48 re-use readme.md in the jotai repo for the introduction page. As the purpose of readme.md and introduction is different, it should be revised. cc @sandren

dai-shi avatar Apr 24 '21 01:04 dai-shi

For now, #43 and #48 re-use readme.md in the jotai repo for the introduction page. As the purpose of readme.md and introduction is different, it should be revised. cc @sandren

@dai-shi I can open a PR with a revised introduction.

Is there anything that you consider "must have" as far as what should be covered in the introduction doc or would we like to make it as minimal as possible, only covering the core API?

sandren avatar Apr 24 '21 02:04 sandren

Well, I actually don't have any concrete idea, so suggestions are welcome. I prefer minimal one, maybe just covering what we show in https://jotai-demo.pmnd.rs/.

dai-shi avatar Apr 24 '21 02:04 dai-shi

these mdx pages can show everything, regular react components, so everything in that website would be possible. im thinking about doing the same for r3f. if we can do mdx why not do the most of it :-D

drcmda avatar Apr 25 '21 21:04 drcmda

This is not about the capability but about the content. I only meant that it shows the minimal api usage. Thanks for the comment actually. (This should clarify. @sandren )

Having that said, I don't have a strong opinion whether we should have a demo in the top page or not. I can say unlike r3f which is "visual", the demo isn't so appealing.

dai-shi avatar Apr 25 '21 22:04 dai-shi