[No QA] Create a readme for API details #9488
Conversation
tgolen
changed the title
|
bump @amyevans for review |
README.md
Outdated
| - All data that is brought into the app and is necessary to display the app when offline should be stored on disk in persistent storage (eg. localStorage on browser platforms). [AsyncStorage](https://reactnative.dev/docs/asyncstorage) is a cross-platform abstraction layer that is used to access persistent storage. | ||
| - All data that is displayed, comes from persistent storage. | ||
| 1. **UI Binds to data on disk** | ||
| 4. **UI Binds to data on disk** |
There was a problem hiding this comment.
NAB, but with these updates, 3 is now missing. I've seen (and like) the convention of numbering them all 1 (since they don't matter anyway -- an <li> tag just gets generated regardless of the number). Let's either return them to 1 or renumber to include 3.
There was a problem hiding this comment.
OK, sure. PHPStorm likes to automatically renumber them, and I agree with using all 1s. I'll update that.
docs/API.md
Outdated
| @@ -0,0 +1,53 @@ | |||
| # API Details | |||
| These are best practices related to the current API used for App. This does not relate to any of our `DeprecatedAPI`. | |||
| # Philosophy | |||
There was a problem hiding this comment.
NAB, but since you've already got an h1 above, I'd recommend bumping all subsequent headings in the doc down a level (e.g. this to h2)
docs/API.md
Outdated
|
|
||
| Pusher listens for an `onyxApiUpdate` event and sends the data straight to `Onyx.update(pushJSON)`. | ||
| ## READ Responses | ||
| This is a response that returns data from the database that didn't exist before. |
There was a problem hiding this comment.
"didn't exist before" - this phrase is slightly confusing to me. I believe it means data that wasn't previously stored in Onyx on the client, but could you reword it to be crystal clear?
There was a problem hiding this comment.
Ah, I completely mis-worded this. Will fix
Co-authored-by: Amy Evans <amy@expensify.com>
Co-authored-by: Amy Evans <amy@expensify.com>
Co-authored-by: Amy Evans <amy@expensify.com>
|
Updated |
|
🚀 Deployed to production by @sketchydroide in version: 1.1.78-8 🚀
|
Details
This contains most of the answers I've been giving to questions from people.
Fixed Issues
None
Tests
None
QA Steps
None