Code Monkey home page Code Monkey logo

oak-docs's People

Contributors

chrisli30 avatar dependabot[bot] avatar imstar15 avatar irsal avatar jacklamchn avatar justinzhou93 avatar laurareesby avatar mattoak avatar nvengal avatar rhuttman avatar stevenpack avatar v9n avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

oak-docs's Issues

Add screenshot of how to earn staking rewards to `_docs/delegation-user.md`

We want users to participate in staking as easy as they can, so let’s provide screenshot and a step-by-step guide for earning staking rewards. I will need you to fill in content for the below two sections in _docs/delegation-user.md

How to stake on Nova Wallet

Coming soon ...

(You do not need to teach user how to download the Nova Wallet app and create a wallet. Start from the Staking tab)

How to stake on Web3go website

Coming soon ...

(You do not need to teach user how to download a Chrome Extention and create a wallet. You can just point them to Subwallet)

Fill out complete information for _docs/requirement.md file

  1. System Requirements (Done)

  2. Operating Requirements
    Machine Running
    Networking stable

  3. Token Requirements
    3.1 OAK前多少位能成为验证人,设置成12位,是按照代币质押的数量来算的(validator + nominator).
    3.2 No minimum staking token requirements.

  4. Slashing
    Slashing will happen if a validator misbehaves (e.g. goes offline, attacks the network, or runs modified software) in the network. They and their nominators will get slashed by losing a percentage of their bonded/staked DOT.

Any slashed DOT will be added to the Treasury. The rationale for this (rather than burning or distributing them as rewards) is that slashes may then be reverted by the Council by simply paying out from the Treasury. This would be useful in situations such as a faulty runtime causing slashing or forcing validators offline through no fault of their own. In the case of legitimate slashing, it moves tokens away from malicious validators to those building the ecosystem through the normal Treasury process.

Validator pools with larger total stake backing them will get slashed more harshly than less popular ones, so we encourage nominators to shift their nominations to less popular validators to reduce their possible losses.

It is important to realize that slashing only occurs for active validations for a given nominator, and slashes are not mitigated by having other inactive or waiting nominations. They are also not mitigated by the validator operator running separate validators; each validator is considered its own entity for purposes of slashing, just as they are for staking rewards.

plancks and numbers for extrinsic calls

Since both collators and delegators are seeing naked tur numbers with all zeroes attached we should probably have an explainer somewhere for newbies and disclaimer about the number of 0s in tur for everyone. (Doesn't need to be included here, just something I'm assuming will come up)

Originally posted by @nvengal in #55 (comment)

Update the validator setup page

The current validator-setup.md is to set up a node, but not a validator. We need to update it to be in sync with the recent Medium article.

Governance fast-track docs is missing; need an example

We need documentations of this, and screenshots of an example
https://docs.moonbeam.network/learn/features/governance/#fast-tracked-external-proposals

Basically, we don’t have any tutorial about fast-tracking and this new page is to demo that with screenshot on local Turing Dev chain.

We just tested out the procedures today as below, but test them out yourself.

  1. A Council member open an external proposal
  2. Councile members vote on the proposal
  3. Once the proposal reaches 3/3, a Tech Committee can close the proposal and start a Tech Committee fast-track proposal.
  4. Tech Committee members vote on the fast-track proposal
  5. Once 2/3 of members vote Aye, the fast-track proposal will become a Referendum.
  6. People vote Aye or Nye on the Referendum.

Clarify inflation numbers in docs

These numbers are based off of the current inflation (5%). If we ever change that these will become inaccurate.

If we want to decouple from the 5% inflation, we could present these numbers differently- 20% of the annual inflation goes to collators, 50% of the annual inflation goes to staking rewards.

My suggestion is easier to maintain in the long term, but if you think this is easier for users to understand in the moment then I'm good with the current text.

Originally posted by @nvengal in #55 (comment)

Add explanation and query examples to Docs website

Content

Page Title for the Left Bar Navigation

GraphQL Data API

Title

OAK Insights: Empowering Developers with the GraphQL Data API

Introduction

Welcome to OAK Insights, where we unleash the full potential of dApp developers building on top of OAK's automation infrastructure. We are thrilled to introduce our GraphQL Data API, a cutting-edge data solution designed to address the limitations and challenges faced by developers. This revolutionary product offers a comprehensive GraphQL Data API that streamlines interactions with the OAK blockchain, empowering developers and dramatically reducing the development costs associated with dApp creation.

To gain a deeper understanding of the capabilities and data formats of the GraphQL Data API, explore the examples provided below.

The GraphQL Data API harnesses the power of the open-source Subquery project to provide a custom, self-maintained data service. You can find our project's GitHub repository at https://github.com/OAK-Foundation/oak-subql.

Use Cases

Simplified Task Tracking: The GraphQL Data API simplifies the tracking and display of user task statuses, eliminating the need for developers to comprehend the intricacies of OAK's block structure. For example, interpreting a Swap smart contract call with multiple hops on Etherscan can be challenging. Our goal is to alleviate this burden, enabling developers to iterate faster and focus on building their dApps instead of reinventing the wheel.

Real-Time Task Notifications: Another powerful use case for the GraphQL Data API is the seamless integration of pub/sub functionality for task notifications. By allowing users to connect their email or Telegram accounts to our dApp, they will receive real-time notifications when their registered tasks trigger on-chain. This feature enhances user engagement and ensures timely interactions with the OAK ecosystem.

At OAK, we are committed to providing developers with the tools they need to unlock the full potential of blockchain automation. Join us on this exciting journey with OAK Insights and experience a new level of development ease and efficiency.

Popular Queries

(In this section we will showcase a few queries, for example)

Full List of APIs

(In this section we can add more basic quries, such as finding accounts, blocks and extrinsics. In my opinion, the more the better)

Page Creation Steps

There’s no need to change Ruby code currently, unless some new functionality is necessary. For content creation usually we only works in the ./_docs folder with Markdown language.

  1. Create a new page in _docs folder
  2. Add yourself to the authors list in _config.yml, and refer to the new name in the new page
  3. Add the new page to the left nav bar, by adding the page name to under oak.js _data/navigation_docs.yml

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.