Hayden Young
44752a464e
refactor: Use hash instead of path when referencing orbitdb addresses.
2023-06-27 14:06:31 +01:00
Hayden Young
cdbe76d708
refactor: Match databases dir to namespace.
2023-06-27 13:33:08 +01:00
Hayden Young
ad13ebe014
fix: Linting.
2023-06-27 13:21:26 +01:00
Hayden Young
88d202008f
docs: The join event fires AFTER heads have been exchanged.
2023-06-27 13:19:44 +01:00
Hayden Young
fbf039b8ff
docs: Better description of the kv storage.
2023-06-27 13:15:31 +01:00
Hayden Young
d91516ffe1
docs: Fix incorrect memberof references.
2023-06-27 13:06:41 +01:00
Hayden Young
603f79f4b2
Change event doc to original.
2023-06-27 13:03:48 +01:00
Hayden Young
2378a143de
Should be a "system", not a "platform".
2023-06-27 13:02:14 +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
Hayden Young
165d3948d3
Merge pull request #88 from orbitdb/docs/oplog
...
Iterate oplog docs
2023-06-27 17:55:16 +08: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
9befa48a7a
docs: Formatting.
2023-06-24 23:50:44 +01:00
Hayden Young
3ceb2aac6c
docs: Remove documentation for params for internal database functionality.
2023-06-24 22:07:30 +01:00
Hayden Young
f719248b2e
docs: Document the findFn signature.
2023-06-24 21:58:08 +01:00
Hayden Young
578f4890b9
docs: Do not expose internal OrbitDBAddress function.
2023-06-24 16:28:49 +01:00
Hayden Young
e6f86fa203
docs: Do not document utils. They are not exposed externally.
2023-06-24 16:18:46 +01:00
Hayden Young
24a2e1ae5f
docs: Change namespace from database to databases.
2023-06-24 16:11:21 +01:00
Hayden Young
ec461809ac
docs: Move customization documentation to READMEs.
2023-06-24 15:46:27 +01:00
Hayden Young
6c4a0ced0c
docs: Remove API docs. Manifest is an internal module.
2023-06-24 15:36:13 +01:00
Hayden Young
8b17f172fa
docs: Move custom identity provider docs to READMEs.
2023-06-24 15:35:48 +01:00
Hayden Young
3af0fc2306
docs: Move custom examples to READMEs.
2023-06-24 15:20:46 +01:00
Hayden Young
a7b611550f
docs: Document the properties of an entry.
2023-06-24 15:18:32 +01:00
Hayden Young
438a8d6d64
docs: Add to log module.
2023-06-24 15:18:12 +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
222c7234fe
refactor: Rename manifest store.
2023-06-22 01:10:12 +01:00
Hayden Young
4a2f2d6809
docs: Distinguish between opening a new db and opening an existing one.
2023-06-22 00:28:05 +01:00
Hayden Young
41230d6150
docs: Fix referenceCount definition.
2023-06-22 00:20:33 +01:00
Hayden Young
877d6b38ea
docs: Metadata new db vs opening db.
2023-06-22 00:17:08 +01:00
Hayden Young
8f88098ee7
docs: Sync default is true.
2023-06-22 00:15:13 +01:00
Hayden Young
7d31c9a763
docs: Correct default ComposedStorage.
2023-06-22 00:00:38 +01:00
Hayden Young
b3fcd36237
docs: Link to IPFSAccessController.
2023-06-21 22:34:08 +01:00
Hayden Young
6c34ff79ab
Merge remote-tracking branch 'origin' into docs/pre-release
2023-06-21 21:47:14 +01:00
Hayden Young
bb0b65a158
Merge pull request #86 from orbitdb/module-loaders-retrieval
...
Module loaders retrieval
2023-06-22 04:23:44 +08:00
Hayden Young
a525d91e8f
docs: Expose access controllers/identity providers/dbs directly. Remove get* functions for AC/IP/DB loaders.
2023-06-21 21:19:35 +01:00
Hayden Young
29a901d6dc
docs: Expand on param.
2023-06-20 00:28:16 +01:00
Hayden Young
f676410543
docs: Do not include in API docs. For internal use only.
2023-06-20 00:26:29 +01:00
Hayden Young
0ca2256b39
docs: PublicKeyIdentityProvider is namespace of IdentityProviders.
2023-06-20 00:24:51 +01:00
Hayden Young
59d8bdc90a
docs: Remove docblocks for Identity. Document Identity properties and functions.
2023-06-19 02:24:52 +01:00
Hayden Young
4fa3b0c115
docs: Remove docblocks for internal functions.
2023-06-19 01:54:54 +01:00
Hayden Young
a243efff71
docs: Remove implementation of custom ACs in API.
2023-06-19 01:35:11 +01:00
Hayden Young
58bcdb4855
docs: Change API output dir.
2023-06-18 20:36:04 +01:00
Hayden Young
4e5b6bb597
chore: Simplify error checking.
2023-06-18 19:33:48 +01:00
Hayden Young
7fafda8416
docs: type is required.
2023-06-18 03:22:18 +01:00
Hayden Young
4c3a338205
refactor: Standardize module loader functions. Do not expose module lists.
2023-06-18 03:05:07 +01:00
Hayden Young
8b93553d0e
refactor: Move database type management to db module.
2023-06-18 02:43:03 +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
