docs icon indicating copy to clipboard operation
docs copied to clipboard

Offline Docs

Open gewenyu99 opened this issue 2 years ago • 5 comments

Doc Idea

This is a more involved feature and will change how you write your app when it's enabled. The Offline docs need to guide users through a story to understand if they should use Appwrite Offline and what problems they need to consider.

Outline

  • [x] Introduction (describe Appwrite Offline, no heading)
  • [x] When Should I Enable Offline? (Describe what problems this solves)
  • [x] Configuring Offline
  • [x] Configuring Offline: Enabling Offline
  • [x] Configuring Offline: Configuring Cache (Mention LRU behavior)
  • [x] Promise Resolution (describe how to handle promise resolution) (UML diagram from Steven)
  • [x] Conflict Resolution

https://github.com/appwrite/homepage/pull/214

gewenyu99 avatar Jan 23 '23 22:01 gewenyu99

Hmm...I'm worried the "introduce the idea that API calls can become blocking" part might be lost/overlooked. I think this concept is really important, so they need to really know this early on before trying to use t.

stnguyen90 avatar Jan 23 '23 22:01 stnguyen90

Hmm...I'm worried the "introduce the idea that API calls can become blocking" part might be lost/overlooked. I think this concept is really important, so they need to really know this early on before trying to use t.

I will introduce it in the Should I Enable Offline? section. The complexities of enabling offline should be briefly mentioned there + link to lower in the page (?)

gewenyu99 avatar Jan 24 '23 22:01 gewenyu99

It's mostly done. Waiting on screenshots from @stnguyen90

gewenyu99 avatar Mar 14 '23 00:03 gewenyu99

It's mostly done. Waiting on screenshots from @stnguyen90

@gewenyu99, do you mean the diagrams? Where do you want them to go?

stnguyen90 avatar Mar 15 '23 16:03 stnguyen90

localhost_2080_docs_offline (1)

localhost_2080_docs_offline (2)

gewenyu99 avatar Mar 27 '23 15:03 gewenyu99