Giter Club home page Giter Club logo

docs's Introduction

IPLD

Welcome!

This repository is the entrypoint to the IPLD project: documentation, specifications, the website, and a great deal of the design work all live here.

**The website published from this repo is online at https://ipld.io/ ** -- you'll probably wish to read it there, rather than see the source form here, unless you're aiming to contribute patches.

IPLD stands for "InterPlanetary Linked Data, and is a series of standards and formats for describing data in a content-addressing-emphatic way. The people who work on IPLD do so because we want a world where it's easy to build decentralized, distributed, and inter-operable applications, and we believe robust data formats and a clear story for content-addressing them is a key piece of leverage towards that goal.

Finding Us

  • For chats with the developers and the community: Join us in any of these (bridged) locations:
  • On Github:
    • Check out all our repos in the https://github.com/ipld/ organization.
    • Github issues can be used for discussing designs, documenting user needs, and submitting bug reports.
    • Git patches and Github pull requests are welcome! (Although discussing changes via issues or one of the chat venues above first is highly recommended.)

The IPLD project has a Code of Conduct (which is shared with the IPFS project). Collaborators, contributors, and any participants in community spaces are expected to be able to abide by this code.

Docs Development

With Node.js>=16 installed:

  • Setup: npm install
  • Build: npm run build
  • Serve locally: npm run start
  • Test link integrity: npm test
  • Cleanup: npm run clean
  • Review: open a pull request and tag @ipld/reviewers
  • Publish: Merge to master and Fleek will do the rest

License

SPDX-License-Identifier: Apache-2.0 OR MIT

docs's People

Contributors

centaur1 avatar harlantwood avatar iryanbell avatar mikeal avatar mvdan avatar oldcryptogeek avatar robinbraemer avatar rvagg avatar tomlisankie avatar warpfork avatar youami avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Finalize migration of schema docs

I’ve copied over the schema docs but I need you to go over them, make sure they are accurate, and take down the old docs so that we don’t have them in two places.

Comments on "Thinking…" tutorial

@mikeal If it would've been a PR, I could've commented there.

In the Addressing section your write:

We encode this data using JSON. Now it has been serialized to a binary representation we can store and/or send to someone else.

I find that confusing as I don't think of JSON as a binary representation. Either make this CBOR or remove the binary representation part. I lean towards CBOR, as doing JSON things within JS might confuse people as it's really similar to their original data.

Later you introduce DAG-CBOR, though even I find it confusing. Why can't you use json? Oh wait, is json not dag-json? If that's the case I would start directly with DAG-CBOR to avoid confusion. If you are new to all this Block.encoder({ name }, 'json') might read as "I want to encode JSON into a Block" and not as "I want this data to be encoded in a Block of JSON".

Getting started in Go

This needs to be written up. Can be completely different from the JS “Getting Started” but it does need to cover a similar level of detail.

Getting started in Rust

This needs to be written up. Can be completely different from the JS “Getting Started” but it does need to cover a similar level of detail.

Replace ipld.io website

The current site is also published to the gateway.

@olizilla I saw that you have some new automation for this that can integrate with actions, can you point me in the right direction?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.