search

Nozbe / WatermelonDB

🍉 Reactive & asynchronous database for powerful React and React Native apps ⚡️
https://watermelondb.dev
MIT License
10.62k stars 600 forks source link

Online docs #6

Closed radex closed 5 years ago

radex commented 6 years ago

Currently, the whole documentation is available just on GitHub in Markdown form.

It would be nice to have a website (like React Native, Jest, React Navigation, etc.) with those docs, and API reference automatically build from source.

It would be great if someone wanted to help out with this!

mobily commented 6 years ago

I think we should use https://docusaurus.io

radex commented 6 years ago

ooh! That's the thing!

xarrijorge commented 6 years ago

Have you decided to use docusaurus or still go with the static site?

radex commented 6 years ago

No decision was made. Doesn't docusaurus generate static sites?

xarrijorge commented 6 years ago

I'm not really familiar with it. I think it is a static site generator (like Gatsby). We could use Gatsby as another alt.

radex commented 6 years ago

I don't have a specific preference — whatever is the easiest and most convenient to set up and maintain. Docusaurus has the advantage of looking like all the cool kids' docs websites

jpbretanha commented 6 years ago

You also could use docz

isurusiri commented 6 years ago

Hi guys, Nice work đź‘Ź

I created a sample using my fork of WatermelonDB in GitBook. If that meets the requirements maybe we could consider it as an option.

Check it out >>

radex commented 6 years ago

Hey @isurusiri, good stuff — is there a way to (easily) add API docs from the JS source?

isurusiri commented 6 years ago

I think documentationjs is what you are looking for, if I'm correct.

Also if docs are in MD format, GitBook can simply import the content and sync all future updates.

radex commented 6 years ago

Hmm @isurusiri… if I understand correctly, this requires documentation comments specifying params, returns, etc… This seems like a waste of developer time, given that we use Flow and so a Babel-based script should be able to just extract all available methods, type information about those methods, a comment above, and spit out HTML docs.

Do you know of a tool that could do something like that? IT would be great to have API docs, but it's difficult for us to justify spending a lot of extra time maintaining it if the code is already largely self-documented through Flow

isurusiri commented 6 years ago

Yeah, got it. I'm not aware of such a tool but I'll look into it.

radex commented 6 years ago

thank you!

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.