ceramicnetwork / docs Goto Github PK
View Code? Open in Web Editor NEWCeramic developer documentation site https://developers.ceramic.network
Home Page: https://developers.ceramic.network
Ceramic developer documentation site https://developers.ceramic.network
Home Page: https://developers.ceramic.network
We can add a few basic CSS styles which will allow us to create more visually interesting content layouts, which will increase comprehension and developer success. I'll follow up here with more detail.
This should be available through mkdocs insiders and somehow needs to be build into our deployment process on gh pages.
Steps to reproduce:
Expectation: go to a page. Reality: nothing happens.
With special attention to multi-writer streams
[ ] Introduction: docs/introduction/index.md
[ ] How Ceramic Works: docs/introduction/how-ceramic-works.md
[ ] Why Ceramic?: docs/introduction/why-ceramic.md
[ ] Ceramic compared to...: docs/introduction/comparisons.md
but not the getting started guide, which is in a different story
This is another features offered through mkdocs material insiders
Include things like decentralized identity, p2p databases, evolutionary files, etc
-In your PR, you must include a description of setup for data persistence of multi address, Ceramic State Store and IPFS Repo. This is a critical step, as otherwise if your node restarts for any reason it will regenerate this file with a new address and all other nodes on the network will lose connection to your old multi address. (I feel like this part gets kind of lost in the box under data persistence, so might be good to be explicit here)
-You can view the multi address in the config file that IPFS creates. By default, it will be located in a directory call IPFS. The multi address includes the PeerID at the end. (I just noticed Catalyst guys seemed lost here, so might be helpful?)
-When you submit your PR, that will automatically trigger a test to make sure you’re successfully connected to the network. If this fails, we will reach out to you to triage the issue. Make sure there are no firewalls blocking your instance and that your port is properly exposed.
And include a link to this in the peerlist README
We got a request from DNS.XYZ to improve our 3ID Connect docs so people can build similar type systems using the same standards and implementation. Specifically they asked us to document:
From js-ceramic & js-did
There are 2 things that should be covered.
When you load a Stream the content won't change by default - the handle you get has the state as of the point in time when it was loaded. But if you call .subscribe()
on it, then the Stream handle will get subscribe to updates to the underlying log, and the contents within the Stream object can change over time
Some examples on how an app can subscribe to changes to a stream and take action on each new update. This is a little bit complicated/confusing right now because Stream is an Observable of StreamState, which means that if you subscribe to it the updates you get have a new StreamState object which is fairly low level and most devs won't know what to do with it. I wonder if we should try to change this so that Stream is an Observable of new Stream objects each tied to the point in time of each new state? So then app code could call subscribe() with a callback that gets a new Stream object each time, which will be more what they are accustomed to dealing with
Include a summary on what Ceramic is and link to new pages that have been recently added
Based on the personas of the audience and what they're likely trying to accomplish or what they're looking for
This will give us access to insiders features such as "was this page helpful", code annotations, better versioning, and other helpful things.
This is somewhat more involved as ideally we can set up the infrastructure first:
Need to work through this
It's giving a 404:
- Foundational Topics:
- docs/foundational-topics/index.md
- Networks: docs/foundational-topics/networks.md
- Streams: docs/foundational-topics/streams.md
- Accounts: docs/foundational-topics/accounts.md
- Transactions: docs/foundational-topics/transactions.md
- Nodes and Clients: docs/foundational-topics/nodes-and-clients.md
- Consensus: docs/foundational-topics/consensus.md
cyph.err — Yesterday at 5:30 AM
the documentation here https://developers.ceramic.network/build/installation/#import-ipfs-with-dag-jose should be updated to use blockcodec-to-ipld-format
instead of multiformats/legacy
this commit removed the placeholder (non-working) schema from the write example, but I wonder if it would be helpful to include something like this preceeding the example, so that the user creates the doc with a real schema
const schema = await ceramic.createDocument("tile", {
content: {
$schema: "http://json-schema.org/draft-07/schema#",
title: "QuickStartSchema",
type: "object",
properties: {
foo: { type: "string" },
},
required: ["foo"],
},
metadata: {
controllers: [ceramic.did.id || ""],
family: "schema",
},
})
On another note, I wonder if it would make sense to have a higher-level method to create a ceramic schema, similar to textile collections, that would type check the schema to ensure it's a valid JSONSchema prior to creating a document and returning a schema URL.
Another question... is there a "catalog" of predefined ceramic schemas somewhere? With the project I am trying to start up, WorldGraph, I hope to use interoperable schemas for linked data, similar to this example from schema.org, so that someone can browse the totality of linked data on ceramic using these known schemas. If this is an area that the ceramic team is interested in exploring, as it's a key capability for my project, I would be happy to research and come up with some proposals for a sort of schema registry. Let me know!
3 options to decide on based on uncertainty/scope:
- Foundational Topics:
- docs/foundational-topics/index.md
- Networks: docs/foundational-topics/networks.md
- Streams: docs/foundational-topics/streams.md
- Accounts: docs/foundational-topics/accounts.md
- Transactions: docs/foundational-topics/transactions.md
- Nodes and Clients: docs/foundational-topics/nodes-and-clients.md
- Consensus: docs/foundational-topics/consensus.md
another minor issue! :)
here's the link: https://developers.ceramic.network/build/installation/
- Ceramic stack:
- Intro to the stack: docs/ceramic-stack/introduction-to-the-stack.md
- Stream programs:
- docs/ceramic-stack/stream-programs/index.md
- Stream program libraries: index.md
- Data models:
- docs/ceramic-stack/data-models/index.md
- Data model libraries: index.md
- Deploying data models: index.md
- Composability: docs/ceramic-stack/data-models/composability.md
- Client APIs:
- docs/ceramic-stack/client-apis/index.md
- Ceramic APIs:
- docs/ceramic-stack/client-apis/ceramic/index.md
- Ceramic JavaScript APIs: docs/ceramic-stack/client-apis/ceramic/javascript.md
- Ceramic HTTP API: docs/ceramic-stack/client-apis/ceramic/http-api.md
- Account APIs:
- docs/ceramic-stack/client-apis/accounts/index.md
- Account JavaScript APIs: docs/ceramic-stack/client-apis/accounts/javascript.md
- Development frameworks: docs/ceramic-stack/development-frameworks.md
Focus on keeping documentation up to date, relevant tests and more.
core client always needs did resolvers, the http client only needs it to do writes
Related to: https://github.com/3box/marketing/issues/102
@ukstv To include GCP!
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.