wax-office-of-inspector-general / wax-developer Goto Github PK

Is your feature request related to a problem? Please describe.
to remove OS specific requirements, I'd like to add a dockerized version.

Describe the solution you'd like
Use docker to host the dev server, which will later enable us to have github actions for build-tests.

Describe alternatives you've considered
Remove necessity to run the dev-server, when editing and previewing can be achieved through gitpod or github code.

Additional context
none

Styling ToDo's

• Searchbox
• navigation top-right
• sidebar items (margin/fonts/arrows)
• language Switch
• Content Components

The repository should have a brief README containing the most important information.
This can include:

• Project Introduction
• Contribution Guidelines
• ...

Staring of with the following two we should be adding tools to our documentation.

Monitoring
All-In-One https://github.com/eosphere/HeadsUp-Monitoring-Alerts
HaProxy Antelope https://github.com/eosswedenorg/antelope-api-healthcheck
HaProxy https://github.com/cc32d9/eosio-haproxy

Is your feature request related to a problem? Please describe.
Currently docs are wide-ranged and cover to many different categories in the navigation.
The structure can be improved and thus digestibility of information.

Describe the solution you'd like
Put roughly the docs shall be restructured to cover the 5 most common personas interacting with developer documentations:

• Node Operation
• API Service
• Smart Contract Development
• Client-Side Development
• Creators and Creator Tools

Describe alternatives you've considered
tbd in this discussion: #88

Briefing for docs content about WAX

What is WAX?
This page aims to provide an overview and introduction to the WAX blockchain. It should cover the fundamental concepts of WAX, such as its purpose, key features, and its role within the broader blockchain ecosystem. The content should explain how WAX facilitates the creation, trading, and ownership of digital assets, including NFTs and collectibles. It should also touch upon the technical aspects of the WAX blockchain, such as its consensus mechanism and interoperability capabilities.

Why WAX?
This page should highlight the unique value proposition of WAX and the reasons why individuals or businesses should consider using the platform. The content should discuss the benefits of WAX, such as its user-friendly infrastructure, scalability, low transaction fees, and the large and active community it offers. It should also mention any specific use cases or success stories that demonstrate the advantages of leveraging WAX for digital asset creation, trading, and community engagement.

WAX Consensus
This page should focus on explaining the consensus mechanism employed by the WAX blockchain. It should delve into the details of how consensus is achieved, whether it's through a delegated proof-of-stake (DPoS) mechanism. The content should outline the benefits of the chosen consensus mechanism, such as scalability, security, and energy efficiency. It should also touch upon any specific features or enhancements implemented within the WAX consensus mechanism.

What is the WAXP token?
This page should provide an in-depth explanation of the WAXP token, which is the native cryptocurrency of the WAX blockchain. The content should cover the utility and functions of the WAXP token within the ecosystem, including its role in transaction fees, staking, voting, or governance activities. It should also mention any specific tokenomics or distribution mechanisms related to the WAXP token, along with potential benefits or incentives for token holders.

WAX Governance
OIG will write this

(WAX Interoperability)
This page should focus on the interoperability capabilities of the WAX blockchain. The content should explain how WAX can interact and integrate with other blockchains or external systems, enabling seamless data transfer, asset portability, or cross-chain functionality. It should highlight the benefits of interoperability, such as increased liquidity, expanded user base, and enhanced utility for digital assets created on WAX.

Wherever possible please expand on each topic, providing detailed explanations, examples, and relevant visuals to create a comprehensive and informative documentation site.

In rng_basics.md they describe that you can use the transaction hash to generate a signing_value inside your contract.

The big issue is, this generates a 256-bit value, which isn't the last parameter that is passed to the function, when the function expects a 64-bit integer followed by the caller.

I figured I'd see if there was some magic I wasn't accounting for, but no, when you actually do this, it will take the bits after the first 64-bits at the caller value, resulting in a random caller and this failing the auth check in the orng.wax contract.

You could do something like this (I tested & verified it), but that would not guarantee 'no collissions' as advertised in the article.

uint64_t uint64_t_from_txhash(){
  auto size = transaction_size();
  char buf[size];
  auto read = read_transaction(buf, size);
  check(size == read, "read_transaction() has failed.");
  auto tx_signing_value = sha256(buf, size);
  auto tx_raw_signing_value = tx_signing_value.extract_as_byte_array().data();
  uint64_t result;
  memcpy(&result, &tx_raw_signing_value, sizeof(uint64_t));
  return result;
}

Also, minor note; if you introduce stuff that require imports, please add them to the article/have a lookup somewhere (sha256 requires an import of <eosio/crypto.hpp>

Is your feature request related to a problem? Please describe.
While we see some limitations in terms of layouti, SEO and we hacked some elemental features, it could be time to move to something more customisable and maintainable

Describe the solution you'd like
An alternative solution is https://vuepress.vuejs.org/

Including a vast variety of plugins to elaborate features for the docs
Localisation: https://vuepress.vuejs.org/guide/i18n.html
Search: https://vuepress.vuejs.org/plugin/official/plugin-search.html#vuepress-plugin-search

Since EOSIO has been rebranded to Antelope the branding in the docs has to be changed accordingly.

The recent refactor of the eosnetwork docs has led to multiple links being broken in our docs.

Every link to https://docs.eosnetwork.com shall be checked and replaced accordingly with the new content. It might even be a solution to link to parent pages, in case the content gets further modified.

Is your feature request related to a problem? Please describe.
We want to make sure, that the site is being built by gh-pages

Describe the solution you'd like
Add CI through github actions. Require CI in PRs to be run before merging.

Describe alternatives you've considered
none.

Additional context

• run with local config
• build site with custom theme

A few PRs need to be checked and merged

Is your feature request related to a problem? Please describe.
For the developer documentation relaunch we moved to a new static-site generator: vuepress.
The way we contribute to and modify the docs has changed only slightly

Describe the solution you'd like
Write a simple guide for people interested into contributing. This shall include:

• Setting up local development instance for testing changes
• Modify content on single pages through "EditLinks"
• How to change sidebar navigation

Hosting a development preview of the dev branch, probably through netlify

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Describe the bug

The footer says "footer content" instead of having any actual content. eg https://developer.wax.io/docs/release-notes/

Is your feature request related to a problem? Please describe.
prepare a wiki for editors

Describe the solution you'd like
step-by-step guide.

Describe the bug
broken link on website

To Reproduce
Click any link on the website, it's mostly broken

Expected behavior
links should redirect to the correct page

Add a Child-ToC component to overview pages, since those didn't have any text added yet.

The following ToC can be inserted into overviews:

<ChildTableOfContents :max="2" title="More inside this section" />

A few broken links appear when deep checking the site.

Some immediate changes are needed here:

• All instances of "MyCloudWallet" should be changed to just "Cloud Wallet". 5ed0cb9
• There are a number of places where WAX isn't fully capitalized. e4abee5
• content: wax.js, move from Build --> Learn. f6b9604
• section cards need a generic design.
• Clicking on a heading (Learn, Build, Operate, Create) does not always auto-expand the tree. 7da708c#diff-4af83e9bb6be12d396e100ee07918c904f6003da8555a637cb1fed905b7a3649R46
• The WAX logo top left is the wrong colour.

Edit this page on github doesn't work

For example on https://developer.wax.io/docs/release-notes/, it goes to https://github.com/wax-office-of-inspector-general/tree/main/docs/release-notes/index.md which generates a 404.

Is your feature request related to a problem? Please describe.
Some small improvements can be made to get more out of the docs.

Describe the solution you'd like

Some suggestions for improvements

• Navigation anchored on the left, like it is now on screens < 1080px
• changes to fonts:
  • mb after headlines increased
  • headlines shall be bold
  • paragraph line-height -15%
  • new monospaced font for codeblocks
  • anchor color darker

New Content Elements

Linking to other Pages

Inside Guides Next/Prev Article, at the end of pages

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Issue/Problem

Recommendations and Example of various Clients and their respective implementation of Wallet Handling:
It's unclear to outline a recommended way of building your client side App, when all of the tooling is scattered around and sometimes lacks proper documentation.
A common place to start is usually UAL

Possible Solution

Client Framework

• React.js - SPA
• Vue.js - SPA
• Next.js - SSR
• Nuxt.js - SSR

Main Scope is to focus the tooling on a broad developer Audience

Code Bundlers
Commonly used bundlers, such as:

• Webpack
• Vite
• rollup/alternatives

There's hurdles now, which we can elaborate on while providing examples. Especially some polyfills needed for Buffer and global namespace, which @includenull mention earlier this week on TG:

Lack of pollyfills and bad documentation don't make it easy to use a lot of these "web3" packages with newer versions of React. So I hope these will give people a jump start.

Wallet & Wallet Adapters

• ual-wax
• ual-anchor
• ual-wombat
• ual-ledger
• others

A Simple example in different implementations is a must and shall cover the following features:

• Authenticate a wallet
• Display Basic Wallet info, e.g. balance, stake, ...
• Simple Form to transact 0.0001 U to someone
• Query custom token balance
• Authentication Session & clearing

Additional context

https://github.com/EOSIO/ual-eosio-reference-authenticator
https://github.com/eosdac/ual-wax
https://github.com/greymass/ual-anchor
https://github.com/pinknetworkx/ual-wombat
https://github.com/EOSIO/ual-ledger
... starteos & scatter

https://github.com/EOSIO/ual-reactjs-renderer
https://github.com/EOSIO/ual-plainjs-renderer

Examples:
https://github.com/includenull/wax-ual-demo-cra
https://github.com/includenull/wax-ual-demo-vite

The relaunched docs host the ability to be localised, just like the archived docs.
We should transfer whatever localised content is available and define each respective locale config to be on-par with the english version.

This include the following tasks:

• set locale config inside theme-config
• create locale sidebar config
• transferring archived localised content

chain.wax.io is referenced in documentation at https://developer.wax.io/docs/api-reference/rpc_api.html
This should be replaced as this is not actually usable.

Is your feature request related to a problem? Please describe.
Some Layout and Styling needs to be applied. The requirements are in a shared figma design.
For ease of coordination I am listing the most apparent styling issues here.

General Styling

• Webfont (H1-H6 + Content)
• font-sizes and font-colors
• proper color-palette changes to theme

Components

• Navbar-Component: Language Switch
• Navbar-Component: Dark-Mode Toggle
• Navbar-Component: Brand above (remove from Navbar)
• Hero-Banner (Background-Image + Headline + Subtitle)

Layouts

• Layout with Sidebar always visible
• Header-Layout with only right slot, inside page content
• Page-Layout: TOC below Title with scroll-anchors to content Headlines
• Layout with Hero-Banner (Content for Hero-Banner from frontmatter)

Additional context

• Example for custom Hero Component: https://theme-hope.vuejs.press/guide/advanced/presets.html#bing-wallpapers
• How to replace components: https://theme-hope.vuejs.press/guide/advanced/replace.html
• Customize Theme: https://theme-hope.vuejs.press/guide/interface/style.html
• Custom components + layouts: https://theme-hope.vuejs.press/cookbook/customize/component.html