avaprotocol / oak-docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation website for users, collators and developers of OAK Network and Turing Network
Home Page: https://docs.oak.tech/
Documentation website for users, collators and developers of OAK Network and Turing Network
Home Page: https://docs.oak.tech/
Fill in text of our pallet development guide to _docs/pallet-development.md, based on our Medium article of quadratic-funding-pallet. Basically we need to show developers how to define data structure in storage, macro, and functions in a pallet.
Refer to other pages and this Markdown guideline. https://www.markdownguide.org/basic-syntax/
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
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)
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 in text of our Bug bounty program to _docs/bug-bounty.md, based on our Medium article.
System Requirements (Done)
Operating Requirements
Machine Running
Networking stable
Token Requirements
3.1 OAK前多少位能成为验证人,设置成12位,是按照代币质押的数量来算的(validator + nominator).
3.2 No minimum staking token requirements.
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.
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)
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.
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.
Fill in text of our Identity guide to _docs/identity.md, based on our Medium article. We don't need to show them how to be a verifier, only the set up their own identity and request judgement. Attach screenshots in the medium article.
Refer to other pages and this Markdown guideline. https://www.markdownguide.org/basic-syntax/
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)
Small issue, but the majority of the bullet numbers are all 1s on this page. You need to use tab to indent anything that is under an time, for example,
The Pallet Development page was written before TimeAutomation was created. @imstar15 do you think if you can update the page with the existing structure and the content of TimeAutomation?
Relative Path:
_docs/pallet-development.md
GraphQL Data API
OAK Insights: Empowering Developers with the GraphQL Data API
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.
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.
(In this section we will showcase a few queries, for example)
(In this section we can add more basic quries, such as finding accounts, blocks and extrinsics. In my opinion, the more the better)
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.
_data/navigation_docs.yml
Fill in text of our Benchmarking guide to _docs/benchmark.md, based on our Medium article.
Refer to other pages and this Markdown guideline. https://www.markdownguide.org/basic-syntax/
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.