Skip to content

Commit

Permalink
Hello, sloth
Browse files Browse the repository at this point in the history
  • Loading branch information
adzialocha committed Jan 17, 2024
1 parent 2fe54ec commit 6b2efbb
Show file tree
Hide file tree
Showing 47 changed files with 484 additions and 65 deletions.
2 changes: 1 addition & 1 deletion website/docs/sdk/index.md → website/docs/sdks/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: SDK
title: SDKs
---

import Tabs from '@theme/Tabs';
Expand Down
24 changes: 0 additions & 24 deletions website/docs/specification/index.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ id: bamboo
title: Bamboo
---

:::danger Deprecated

This section will soon be replaced with our new [namakemono](/specifications/namakemono) data type which is similar, but cooler.

:::

_Requirements in this section refer only to how p2panda specifies use of bamboo._

:::caution Requirement BA1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ id: key-pairs
title: Key Pairs
---

:::danger Deprecated

This section will soon be replaced with our new [namakemono](/specifications/namakemono) data type which is similar, but cooler.

:::

:::caution Requirement KY1

Clients MUST use Ed25519 as the Digital Signature Algorithm for Bamboo.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ id: operations
title: Operations
---

:::danger Deprecated

This section will soon be replaced with our new [namakemono](/specifications/namakemono) data type which is similar, but cooler.

:::

- Operations represent atomic data changes.
- Operations are published as the payload of _Bamboo entries_.
- Operations are identified by the hash of their Bamboo entry.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
16 changes: 16 additions & 0 deletions website/docs/specifications/aquadoggo/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: aquadoggo API
---

[aquadoggo](https://github.com/p2panda/aquadoggo/) is a reference node implementation for p2panda. It is a intended as a tool for making the design and build of local-first, collaborative p2p applications as simple as possible, and hopefully even a little fun!

aquadoggo can run both on your own device for local-first applications, or on a public server when acting as shared community infrastructure. Nodes like aquadoggo perform a number of tasks ranging from core p2panda data replication and validation, aiding the discovery and establishment of connections between edge peers, and exposing a developer friendly API used for building applications.

:::info Definition: Requirement Codes

In this document we assign a code to each specification requirement, this is to make it easier for implementers to track the requirements they need to meet.

:::

[bamboo]: https://github.com/AljoschaMeyer/bamboo
[rfc2119]: https://datatracker.ietf.org/doc/rfc2119/
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions website/docs/specifications/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Specifications
---

## namakemono

The core specification of p2panda is *namakemono* (Japanese for "sloth"), it defines the core data type for offline-first applications and gives them efficient replication, deletion, capabilities, encryption and more.

* 🦥 [Namakemono specification](/specifications/namakemono/)

## aquadoggo API

p2panda designed a toolbox of SDKs for application developers to easily build full p2p clients for the web, mobile or desktop. This specification is a detailed outline of all APIs and data types used by it.

* 🐬 [aquadoggo API](/specifications/aquadoggo/)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6b2efbb

Please sign in to comment.