massalabs / docs Goto Github PK
View Code? Open in Web Editor NEWMassa Protocol Documentation
Home Page: https://docs.massa.net/
Massa Protocol Documentation
Home Page: https://docs.massa.net/
Implement the build API section introduced in #34
Massa coins official symbol will be XMA.
Currently in documentation where we are referring to values of Massacoin, we use Massa or MAS, all need to be changed to XMA.
To do in all files in docu-dev repo
As described here: https://github.com/massalabs/docu-dev/pull/29/files#diff-cdf71e5d0cc630466deb272dc176476bc993356cda9c3f0e3fb7bf3293d4fc7e
This includes:
create the subdirectory if needed
update the sidebar and the docusaurus config
The learn section could benefit from a short introduction that highlights the main selling points of Massa without going into the details. Right now it's a bit complicated for the general public.
It's probably worth linking the video somewhere as it's probably the most accurate/complete and up to date video tutorial we have.
Install docusaurus using typescript:
npx create-docusaurus@latest docu-dev classic --typescript
Create a new section explaining how to test on massa.
This include:
See #90 (comment)
We took the current Massa docs section Architecture -> Introduction, and turned it into a new page which explains basic concepts of Massa blockchain.
The objective of the task is to create additional content, so that readers get a concise, not-too-techy introduction to Massa's main terminology.
Below I wrote suggestion on how to improve each sub-section.
The content structure can be found in this PR #34.
I suggest just linking small PRs for each or each few sections.
**1. Basic concepts → Ledger: -> DONE
To add:
2. Basic concepts → Address: -> DONE
To add:
3. Basic concepts → Smart Contract:
To add:
4. Basic concepts → Autonomous Smart Contract
To add:
5. Basic concepts → Storage cost section: -> DONE
To add:
6. Basic concepts → Operations section:
To add:
7. Basic concepts → Smart Contract → Execute SC operation:
To add:
8. Basic concepts → Smart Contract → Call SC operation:
To add:
9. Basic concepts → Smart Contract operations -> Tip (:::tip :::)
to add:
10. Basic concepts → Transaction fee
To add:
11. Basic concepts → Block
To add:
As described here: https://github.com/massalabs/docu-dev/pull/29/files#diff-630a17ee06e91c64b8a0996df047c00ff37bfb16728f9be2f15dcf34c37c8e32
This includes:
Even if not perfect this doc will soon be better than the one that is available right now. To be ready to switch we need to do the following:
General:
Build Section:
Tutorial section:
Once everything else is done:
That's what I see for now. Maybe I'm missing things. Feel free to complete. There might be things overlapping with existing issues (feel free to link them here).
Let's target to have a first release ready version for the end of June and improve from there!
Review info from here, update the content if needed, and add it to the subsection in 'autonomous-sc file'.
Create a diagram like in Operation lifecycle, that follows all mentioned info in the text.
Blocked until we have a v1 (see check list).
Following comment here: #54 (comment)
Update the example with new Max supply of Massa coins
As described here: https://github.com/massalabs/docu-dev/pull/29/files#diff-3fe3b59d1988fd4cfbc13f04b79a9c3912f38fc45117af60d1c8ea9143b4cabb
This includes:
create the subdirectory if needed
update the sidebar and the docusaurus config
Fill the SDK page in the Build section.
Create a new section explaining how to deploy a smart contract on massa.
This include:
$npm run build
> [email protected] build
> docusaurus build
[INFO] [en] Creating an optimized production build...
✔ Client
✔ Server
Compiled successfully in 11.80s
✔ Client
● Server █████████████████████████ cache (99%) shutdown IdleFileCachePlugin
stored
[ERROR] Unable to build website for locale en.
[ERROR] Error: Docusaurus found broken links!
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken links found:
- On source page path = /docu-dev/docs/build/smart-contract/webassembly-module:
-> linking to ./quick-start (resolved as: /docu-dev/docs/build/smart-contract/quick-start)
at throwError (/home/greg/code/docu-dev/node_modules/@docusaurus/logger/lib/index.js:76:11)
at handleBrokenLinks (/home/greg/code/docu-dev/node_modules/@docusaurus/core/lib/server/brokenLinks.js:153:47)
at async buildLocale (/home/greg/code/docu-dev/node_modules/@docusaurus/core/lib/commands/build.js:186:5)
at async tryToBuildLocale (/home/greg/code/docu-dev/node_modules/@docusaurus/core/lib/commands/build.js:41:20)
at async mapAsyncSequential (/home/greg/code/docu-dev/node_modules/@docusaurus/utils/lib/jsUtils.js:34:24)
at async Command.build (/home/greg/code/docu-dev/node_modules/@docusaurus/core/lib/commands/build.js:76:21)
[INFO] Docusaurus version: 2.4.0
Node version: v19.7.0
The context
This PR #34 adds the Operation lifecycle sectio (operation-lifecycle.mdx file) which is a copy/paste from the current page in docs.
The objective of the task is to:
Create a quick start section that will propose a Hello world DApp:
The idea is to have a step by step guide as well as an already working git repo.
You get get inspiration from https://docs.near.org/develop/quickstart-guide
Current Massa docs section Architecture included the lengthy description of Endorsement mechanism, which don't fit the purpose of the Learn segment where will be located in the new Documentation we're making.
The objective of this task is to write the content of this new section 'Consensus quality initiatives'.It will provide the list of mechanisms Massa’s consensus has in place that make it optimal/better/more efficient.
The listed mechanisms in the Massa docs I found are:
The content structure can be found in this PR #34 - consensus-quality.mdx file.
1. 1-2 Intro paragraph:
To add:
2. Endorsements - improvements:
Currently under review in PR #34. I summarized some parts.
To do:
3. Slashing - full write up:
To add:
4. Node banning - full write up:
To add:
We should chose a colour palette here: https://github.com/massalabs/docu-dev/blob/main/src/css/custom.css
Fill the Project Layout page under Smart Contract in the Build section.
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.