Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Offline Docs #328

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open

Offline Docs #328

wants to merge 32 commits into from

Conversation

gewenyu99
Copy link
Contributor

@gewenyu99 gewenyu99 commented Jan 23, 2023

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

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

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

@gewenyu99 gewenyu99 changed the title Init offline docs Offline Docs Jan 23, 2023
@stnguyen90 stnguyen90 requested review from stnguyen90 and removed request for stnguyen90 January 23, 2023 22:34
@stnguyen90
Copy link
Contributor

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.

@gewenyu99
Copy link
Contributor Author

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 and others added 23 commits January 25, 2023 21:38
Co-authored-by: Bradley Schofield <[email protected]>
@gewenyu99 gewenyu99 marked this pull request as ready for review March 14, 2023 00:35
@gewenyu99 gewenyu99 requested a review from stnguyen90 March 14, 2023 00:35
@gewenyu99
Copy link
Contributor Author

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

@stnguyen90
Copy link
Contributor

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

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

@gewenyu99
Copy link
Contributor Author

gewenyu99 commented Mar 27, 2023

localhost_2080_docs_offline (1)

localhost_2080_docs_offline (2)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants