Git Product home page Git Product logo

sora-docs's Introduction

SORA documentation

A central repository that contains documentation for SORA. Whether you're a beginner or an advanced user of blockchain technology, or a developer, you'll find something useful there.

Check out the contribution guidelines if you are interested in contributing to SORA documentation.

sora-docs's People

Contributors

andreykortosov avatar baotn166 avatar bgodlin avatar bragov4ik avatar c4twithshell avatar danijelcbs avatar dependabot[bot] avatar f33r0 avatar grugonion avatar javitoarroba avatar lsvs avatar mishokanaria avatar mrpositivekzn avatar outoftardis avatar pakrentos avatar shlavik avatar sorabot avatar takemiyamakoto avatar tarmovannas avatar tieumsan avatar vovac12 avatar wrricht3r avatar

Stargazers

 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

sora-docs's Issues

Make at least 2 approvals required to merge a pull request

To enhance the quality and oversight of our codebase, I suggest implementing a requirement for at least two approvals before merging a pull request. This will ensure that changes undergo thorough review and receive input from multiple team members, leading to a more robust and reliable codebase.

Consider restructuring the Guides section

instead of having our product as the parent page, we should focus on specific features. For example, we can have a page called "Staking" and then break it down into sub-pages like "Staking in Polkaswapโ€ and "Staking on Mobile." It just makes more sense, you know? Let me know what you think.

Linking RFP repo

When users interested in creating a Request for Proposal (RFP) visit the /rfp page and proceed to the corresponding GitHub repository, they may be surprised by the lack of activity there. This is because all the issues related to ecosystem projects are created directly in their corresponding repositories. To address this, we should either establish the RFP repository as a gateway to all issues related to the ecosystem or explicitly provide links to the issue lists in the corresponding repositories.

Environments

Currently, there is no aggregated list of live endpoints available. It would be beneficial to provide such a list to allow users easy access to metadata and showcase the capabilities of the blockchain.

[Documentation]: SORA Synthetics

Problem statement

We need to add documentation for the XST Platform on the new wiki.

The documentation should explain or link to articles explaining the XST Platform from the business perspective (use cases, value for the users) and from the technical perspective (components involved, pallets implemented, sequence diagram) in the new wiki, in the relevant sections of the wiki.

Description

No response

Definition of Done

  • Explanation of the XST Platform - Business value, use cases (I can help with that if needed)
  • Explanation of the XST Platform - Components, Pallets, Sequence Diagrams

Requirements

Review from the relevant stakeholders (PM, Tech leads from client applications, Ecosystem manager)

Start Here page for participating in the SORA ecosytem

Based on Makoto-san's grand introduction to how people can be active participants in SORA, a page with a name similar to Start Here should be made containing information covering;

There are many ways to contribute to the growth of SORA;
๐Ÿ“š You can learn about economics
๐Ÿ”’You can stake to protect the network
๐Ÿฅ›You can provide liquidity
There are lots of things to do, study the ecosystem and find out how what you do today can make the most significant impact on humanity in the coming years.

[Documentation]: SORA Card Library Integration Guide

Problem statement

We want to enable other wallets to easily integrate SORA Card. For that we need to provide a guide for development teams to integrate SORA Card by using the libraries we developed.

Description

No response

Definition of Done

  • SORA Card integration guide added to the SORA wiki

Requirements

  • Library presentation & overview
  • Class diagrams (when relevant)
  • Sequence diagrams (registering & KYC, payments, referral system)

Move relevant pages from the current wiki

Problem

The new documentation is missing content from certain pages and only includes references to them. This can be seen in the following example (running a node):

Copying and pasting the markdown file results in an error, as shown in the following figure:

Screenshot 2023-04-21 at 12 27 22

Resolution

To resolve this issue, manual editing of the markdown files is necessary to ensure compatibility with the new wiki platform, vitepress.dev.

๐Ÿ”ด Builders Programme Form in Github

Currently, submitting a project to the builder program requires filling out a Google form, which implies that the submission is not publicly available. It is important to consider that the crypto community often has reservations about using Google services. Exploring alternative submission methods or addressing privacy concerns would be beneficial for wider participation.

Feedback on the latest contributions

๐Ÿ”ด Document Essential SORA Blockchain Features

The documentation does not provide descriptions for several essential features such as liquidity proxy, governance, and Demeter. It is crucial to include detailed explanations and information for these features to ensure a comprehensive understanding of the ecosystem.

Add CI/CD

Problems

There is no CI/CD present for this project.

Requirements

More contribution guidelines

It would be valuable to include development contribution guidelines and process schemas to assist developers in understanding how to contribute effectively to the project.

References to the other channels

The wiki appears to be disconnected from other popular channels, such as Medium. It would be beneficial to include references or even embed content from these channels within the wiki to create a more cohesive and interconnected documentation experience.

Comprehensive Guide on Opening an HRMP Channel with SORA

Description

In order to foster seamless collaboration and interoperability within the Dotsama ecosystem, it is crucial to provide ecosystem developers with clear and detailed guidelines on how to open an HRMP channel with us. This comprehensive guide aims to empower developers by equipping them with the knowledge and resources necessary to establish efficient HRMP channels, enabling the exchange of information and value across different Substrate-based projects.

Relevant materials

Relevant issues

DoD

Feel free to drop the guide as a comment. This way, we'll have the markdown file ready for easy integration into the documentation platform after the review. It'll make the process quicker and more convenient for everyone involved.

๐ŸŸข Blockchain Codebase Info

The current documentation lacks sufficient references to the actual blockchain codebase, resulting in a disconnect between the high-level descriptions and the technical implementation. It would be beneficial to include more references to support the high-level descriptions with specific technical implementation details. However, we should be cautious not to duplicate information found in the RUST documentation.

Update changelog page

Q:

There is a "Changelog" page (https://raw.githubusercontent.com/sora-xor/sora-docs/develop/src/changelog.md) in the wiki that doesn't seem to contain much info. It's currently a part of the "Getting started" section, but I don't think it's relevant there. Maybe the Ecosystem chapter would be a better place for it? Also, it contains empty links, should they be updated?

A:

This should link to the SORA backend changelogs on git, I think we need some more work on these

Glossary

A glossary is missing from the documentation, making it challenging for users to find concise definitions of keywords mentioned throughout the material. Adding an aggregated glossary page would greatly enhance the usability and accessibility of the documentation.

๐ŸŸก SORA Ecosytem Overview

The documentation lacks an ecosystem overview that provides a clear architectural illustration of the main components, including the solo-chain, parachains, and other relevant projects. Including such an overview would greatly aid users in understanding the overall structure and relationships within the ecosystem.

Address Grug's feedback for Old Wiki

Our dear contributor Grug left the following feedback

  1. JpGames tokens are burned.
    2)I can't find XST tokenomics.
    3)TBCD tokenomics and info are missing.
  2. staking page is misleading. it doesn't tell anything about staking.
    5)Fearless wallet app page in wiki needs to mention that FW have not will have XOR staking. (With tutorial please).
    6)Please add an nice image of the wallet in this page. https://wiki.sora.org/ecosystem/sora-mobile-app

I have addressed the feedback in the old wiki, now it needs implementation on the new one

Polkaswap Category to Match Old Wiki Setup

Hello,
It has been brought to our attention that segmenting the Polkaswap information could be difficult for new users, within the "Participate in the SORA Economy" section, can we please add a Polkaswap section that includes user guides, from inexperienced to advanced, similar to the structure in the old wiki?
Image attached,
Thank you.
IMAGE 2023-07-11 13:53:26

Fix images in create-an-address.md

The second part of the create-an-address.md file contains links to images that are either missing or incorrect. In #40 I've put comments around such instances for now, but it should be fixed properly.

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.