Skip to content

Commit

Permalink
docs(GITBOOK#135): C Links to GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyTubongbanua authored and gitbook-bot committed Aug 15, 2024
1 parent 6c38bc9 commit a433bdb
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/learn/sdk/atid-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ The `AtKey` class API reference is available [here](https://pub.dev/documentatio
{% tab title="C" %}
## C

You can find all these examples also on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c).

### Introduction

There are three kinds of atKeys:
Expand Down
2 changes: 2 additions & 0 deletions docs/learn/sdk/crud-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,8 @@ The `AtClient` class API reference is available [here](https://pub.dev/documenta
{% tab title="C" %}
## C

You can find all of these examples on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c).

### Table of Contents

* [#introduction](crud-operations.md#introduction "mention")
Expand Down
6 changes: 6 additions & 0 deletions docs/learn/sdk/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ await atClient.notificationService.notify(
{% tab title="C" %}
## C

You can find the full code of this example on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/4a-monitor#4a---monitor).

### Table of Contents

* [#introduction](events.md#introduction "mention")
Expand Down Expand Up @@ -175,6 +177,8 @@ atclient_monitor_response_free(&response);
#### Example Application
You can find the full code of this example on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/4a-monitor#4a---monitor).
```c
#include <atclient/atclient.h>
#include <atclient/atclient_utils.h>
Expand Down Expand Up @@ -368,6 +372,8 @@ atclient_notify_params_free(&notify_params);
#### Example Application
You can find the full code of this example on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/4b-notify#4b---notify).
```c
#include <atclient/atclient.h>
#include <atclient/atclient_utils.h>
Expand Down
4 changes: 4 additions & 0 deletions docs/learn/sdk/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ Then open the Advanced settings drop down and click `Generate New API Key`:
{% tab title="C" %}
## C

Find the full example on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/1-authentication#1---authentication).

### 1. Fetch your atServer's address from the production atDirectory

First, include `atclient_utils.h` and `#include <atclient/constants.h>` at the top of you program.
Expand Down Expand Up @@ -239,6 +241,8 @@ atclient_free(&atclient);

Here is an example application that authenticates my atSign `@jeremy_0`.

This code is also available on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/1-authentication#1---authentication).

```c
#include <atclient/atclient.h>
#include <atclient/atclient_utils.h>
Expand Down
2 changes: 2 additions & 0 deletions docs/sdk/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,8 @@ Now you are ready to begin developing!

Setup a CMake project which includes the atSDK package suite.

The full example can be found [here](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/0-my-first-c-app).

#### 1. Ensure you have a C Compiler, CMake, and a build automation tool

The method at which you decide to use to install these prerequisites are up to you. These three tools can be installed using either `apt` or `pip`.
Expand Down
4 changes: 4 additions & 0 deletions docs/sdk/synchronization/connection-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
{% tab title="C" %}
## C

The full example code can be found on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/5a-hooks#5a---hooks).

### Connection Hooks

Connections hooks are useful for when you want to add additional control to the connection lifecycle in the atSDK. This means you as the developer can implement things like automatically reconnecting when connections drop (example below).
Expand Down Expand Up @@ -42,6 +44,8 @@ atclient_connection_hooks_set(&(atclient->atserver_connection), ATCLIENT_CONNECT
#### Print something before we write to the atServer
The full example code can be found on our [GitHub](https://github.com/atsign-foundation/at\_demos/tree/trunk/demos/get\_started\_c/5a-hooks#5a---hooks).
```c
#include <atclient/atclient.h>
#include <atclient/atclient_utils.h>
Expand Down

0 comments on commit a433bdb

Please sign in to comment.