inkdropapp / api-docs

API documentation for Inkdrop
https://developers.inkdrop.app/
Other
17 stars 6 forks source link

feat(modules): add data-store and related pages #11

Closed Keisir closed 1 year ago

Keisir commented 1 year ago

Adds documentation for the data-store and related pages. Based on the following pages of the old documentation.

As always, I have made some minor changes and added or updated some examples.


While migrating the documentation, I noticed that the structure/hierarchy could be revised in the future. In the documentation everything is shown on "one level", but in reality it looks different. I will make a proposal for this after the documentation migration is complete.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2023 6:59pm
craftzdog commented 1 year ago

Great!

I think /data-access/database can be changed to a page about the event subscriptions like /data-access/events because we've already covered the properties for each data model like notes. So, the "Properties" section can be removed. wdyt?

Keisir commented 1 year ago

I think this is a great idea!

I thought about doing something similar during the migration. But for now, I decided not to make any major changes to the documentation directly. I want to make sure that no information will get lost. Since the "Data Access" section is almost complete, I think this should not be a problem.

craftzdog commented 1 year ago

Cool! Thank you ✨

I thought about doing something similar during the migration. But for now, I decided not to make any major changes to the documentation directly. I want to make sure that no information will get lost.

Got it. Let me know if you have any suggestions!