atsign-foundation/at_demos

Get Started with C Demos

Closed this issue · 3 comments

JeremyTubongbanua commented

Write demos to help aid the doc site with examples.

  • 1-authentication
  • 2a-create-public-atkey
  • 2b-create-self-atkey
  • 2c-create-shared-atkey
  • 2d-create-atkey-with-metadata
  • 3a-put-public-key
  • 3b-put-self-atkey
  • 3c-put-shared-atkey
  • 3d-get-public-atkey
  • 3e-get-self-atkey
  • 3f-get-shared-atkey
  • 4a-monitor
  • 4b-notify
  • 5a-hooks
JeremyTubongbanua commented

@XavierChanth I would like to propose this structure for the demos

 1-authentication
 2a-atkey
 2b-atkey-with-metadata
 3a-put-self-key
 3b-get-self-key
 4a-put-shared-key
 4b-get-shared-key
 5a-put-public-key
 5b-get-public-key
 6a-notify
 6b-monitor
 7a-hooks

Is that cool?

  • 👍1
XavierChanth commented

Yeah, you could also do something like this:

The docs aren't numbered but they are in this order

- Get started (mainly would be the CMakeList.txt file)
- Authentication
- atKey Reference
- CRUD ops
- Notifications
- Extras (such as hooks)

e.g. Then you could say on the CRUD page, the CRUD examples are all number 3.

 1a-authentication
 2a-atkey
 2b-atkey-with-metadata
 3a-put-self-key
 3b-get-self-key
 3c-put-shared-key
 3d-get-shared-key
 3e-put-public-key
 3f-get-public-key
 4a-notify
 4b-monitor
 5a-hooks

But whatever you prefer, fine by me.

  • 👍1
JeremyTubongbanua commented

Found a bug with fetch content, allocating 1 SP to fix documentation on gitbooks and examples