32 Commits

Author SHA1 Message Date
Hayden Young
ff9d04b714 docs: Do not use unexposed getAC function. 2023-11-07 23:37:17 +00:00
Hayden Young
0eb228b530 docs: Remove non-exported getAccessController from docs. 2023-11-06 17:55:24 +00:00
Hayden Young
e7b6efeeb4 docs: Version API. 2023-09-18 14:39:55 +01:00
Hayden Young
af8f4df335 docs: Install latest stable version. 2023-09-18 12:11:12 +01:00
Hayden Young
7ea08339c8 docs: Incorrect param. Fixed. 2023-09-07 13:43:25 +01:00
Hayden Young
246660ca89 docs: Correct import for custom db example. 2023-09-07 13:17:28 +01:00
Hayden Young
06ea870308 refactor: Use an access controller. 2023-09-07 09:34:48 +01:00
Hayden Young
7888ff06a3 refactor: Use a database type. 2023-09-07 09:29:33 +01:00
Hayden Young
7e66226122 docs: ACs, DBs and IDPs should have type exposed for correct registration. 2023-09-05 22:54:32 +01:00
Hayden Young
c08bf8d2d0 refactor: Move type and verifyIdentity into IDP function. Pass provider as using provider param. 2023-09-04 10:39:25 +01:00
Hayden Young
b7956db016 docs: Update custom IDP usage. 2023-09-04 00:56:26 +01:00
haad
fb38c51625 Fix orbitdb package name in API docs 2023-08-30 16:06:46 +03:00
haad
d4918e750a Update README and getting started guide 2023-08-24 17:13:29 +03:00
Hayden Young
5079d490d9 refactor: Rename OrbitDB entry point. 2023-08-15 00:55:27 +01:00
Hayden Young
86358ea2c5 docs: Clean jsdoc-generated API. 2023-06-30 16:18:57 +01:00
Hayden Young
008c97244b
Merge pull request #89 from orbitdb/docs/iterate-docs
Iterate docs
2023-06-27 18:24:33 +08:00
haad
39a5f425e2 Iterate documentation 2023-06-27 12:56:53 +03:00
haad
d81d390020 Iterate Oplog docs 2023-06-27 10:31:45 +03:00
Hayden Young
bba53d730a docs: Add a README home page to API. 2023-06-25 00:18:39 +01:00
Hayden Young
0205ee3a95 docs: Include README. 2023-06-24 23:55:24 +01:00
Hayden Young
ec461809ac docs: Move customization documentation to READMEs. 2023-06-24 15:46:27 +01:00
Hayden Young
8b17f172fa docs: Move custom identity provider docs to READMEs. 2023-06-24 15:35:48 +01:00
Hayden Young
fca1433f73 docs: Describe keystore and the alternative ways to set its location. 2023-06-24 01:52:03 +01:00
Hayden Young
8769aa1277 docs: Describe the identity and manifest objects as linked data. Give examples. 2023-06-22 22:42:11 +01:00
Hayden Young
85e6848f4c
Pre release (#85)
* docs: Update README to match new version.

* docs: Update events example to use new API.

* docs: Correctly print out db query results.

* test: Remove concurrent.

* test: Remove unimplemented and 3rd party AC tests.

* test: Remove unimplemented and 3rd party identity tests.

* docs: Move jsdoc config to conf directory.

* Point package.json main at index.js to access all exported functions.

* docs: Vetted AC docs; these examples should work if implemented in code. Explicitly show orbit-db function imports.

* docs: Fix incorrectly declared write objects.

* docs: Improved canAppend documentation. Better JS syntax highlighting.

* docs: wss and define filters for localhost separately.

* docs: Simplified webSockets implementation with filters.

* docs: Return manifest json only (no hash). JS highlighting.

* docs: Remove operations documentation.

* docs: Update heading levels.

* docs: Differentiate between db types which expose put/add function.

* docs: Correctly import IPFS and pass config.

* docs: A simple method for full db replication.

* docs: Link to existing examples of db implementation.

* docs: Update heading.

* docs: JS code formatting. import statements.

* docs: Expand on the concepts of identities and identity management.

* docs: Describe head sync-ing and full replication.

* docs: Comprehensive explanation of setting up a db and sync-ing/replicating data across peers. Examples can be run in node.js.

* docs: Syntax highlighting. Correct code implementation for custom/3rd party storage implementations.

* docs: Getting started cleanup.

* docs: Manifest as an IPLD data strcture.
2023-06-18 02:13:54 +08:00
Hayden Young
5ab0bcdbf5
Docs (#66)
* docs: Access controllers.

* test: Re-open an existing db using its address.

* docs: Simple db interaction.

* docs: Basic Identities.

* docs: Storage.

* docs: Implementing a custom database.

* docs: Example OrbitDB AC.

* docs: Use identity id when customizing access.

* docs: canAppend.

* docs: Graphically describe log joining.

* docs: Update db types.

* docs: Sync-ing.

* docs: Reverse flow arrows.

* docs: Logical clock.

* docs: DB address and manifest.

* docs: Move ops description to db.

* docs: CRDT.

* docs: Peer discovery, connecting ipfs nodes, orbitdb replication.

* docs: Change file name case to match other documentation solutions (e.g. IPFS/libp2p).

* docs: Links to CRDT papers.

* docs: A getting started to get up and running quickly.

* docs: Move replication to own readme.

* docs: Links to various js-libp2p connection config.

* docs: Examples for connecting two node servers.

* docs: Server to browser connection.

* docs: Replication how-to.

* docs: Remove SYNC.

* docs: Simplify oplog discussion.

* docs: Connecting to IPFS in the browser.

* docs: Topics moved to separate docs.
2023-05-05 00:33:36 +08:00
haad
7a274bd84d Update documentation 2016-10-04 19:07:33 +02:00
haad
2dd9956425 Cleanup 2016-03-21 10:00:36 +01:00
haad
55eac964d7 Remove seq and ver, use only IPFS hash for ordering. Remove dependency on POST for db operations. 2016-03-14 12:55:19 +01:00
haad
3fb6261ee9 Rework ordering.md document 2016-03-13 13:50:46 +01:00
haad
c5cce8466c Rework docs 2016-03-13 13:25:21 +01:00
haad
bb479bee4c Rename docs 2016-03-03 15:24:28 +01:00