dominant-strategies/quai-docs

Open-source documentation for the Quai Network protocol.

quai-docs's Issues

Stratum Proxy Tutorial/Spec

Create issue templates

Create templates for common issues (typos, new page request, translations, etc.)

Verify page routing works correct with dev build

Base URL is currently set to /docs/ with the idea that this page will be hosted at https://qu.ai/docs/

Currently, when hitting localhost:3000 or localhost:3000/docs/ the page returns a Page Not Found error, need to investigate how to correctly route the pages for / and /docs to resolve to /docs/introduction/

🔗[BROKEN LINK] In docs/participate/iron-age-testnet.md Page

Where is the broken link?
Page: docs/participate/iron-age-testnet.md
Lines: 25

What word(s) is/are incorrectly linked?
Contract Deployment Tutorial(s)

What is the CURRENT, broken link address you are directed to?
/develop/tutorials/solidity.md

What is the CORRECT, updated link address you should have been directed to (If you don't know, put IDK)?
IDK

Multi-language support

📝[PAGE REQUEST] Glossary

What is the title of your proposed page?
Glossary

Does this proposed page solve an existing problem with the docs? Please describe.
Provides central hub for definitions of complex technical terms

Where would this page fit in the existing docs hierarchy?
At the very bottom of the docs hierarchy

What content goes on your proposed page?
A list of terms and their respective definitions

📑[PAGE REQUEST] Contributing Wiki Page

Is your feature request related to a problem? Please describe.
No

Describe the solution you'd like
A clear and concise documentation page on how to contribute

Additional context
Relevant example https://hasura.io/docs/wiki/

Re-add docs home page

*Need 6 top level things (user categories/journies) - MAX

• Implementation - JUDI

Update QRC20 deploy tutorial gas to 5M

For explanation, check this issue in hardhat-example: dominant-strategies/hardhat-example#26

💡[SUGGESTION] Replace absolute links with relative links

Is your feature request related to a problem? Please describe.
Whenever changing architecture of docs, it breaks all links

Describe the solution you'd like
Replace absolute links with relative links

Add broken link scraper

• Need this with the volume of links in docs to know if a link gets broken, getting extremely complex
• Notify us in some way (OhDear bot maybe?) if there is a broken link in docs

Edit pagination

Make the "previous" and "next" pages relevant to the current page/the user's progression rather than auto-generated

SEO Optimization

Marketing team group effort

Smart Contract Deployment Tutorial

Unsure if this will be with Hardhat or Quais.js

GPU Miner Tutorial/Spec

Complete Infrastructure Pages

Infrastructure pages include Block Explorers, Wallets, Faucet, and the participate intro need to be filled in when finalized information is available.

Seperate README into both README and CONTRIBUTING

Bump Docusaurus version to fix Flux peer dependency issue

Upon upgrading to Docusaurus v3, the @docusaurus/plugin-debug package introduced a peer dependency issue related to flux and @microlink/react-json-view that throws warnings when installing packages.

The issue has been brought up to the Docusaurus team in issue 9486 and is actively being resolved. When this issue gets resolved in the next minor version, package versions in this repo need to be updated.

Set up eslint and prettier configuration

Update Node and Miner Tutorials

Node and miner tutorials in run-a-node.mdx and run-a-miner.mdx need to be updated to current install/run standards.

Add Cuda installation instructions

Add SolidityX to language page

🗒️[UPDATE CONTENT] Update FAQ Page

What page needs its content updated?
GPU Miner FAQ

What is out-of-date?
Unfortunately we don't allow distribution of binaries at the current moment. We will be working on ways to enable this in the future with reproducible builds or official tags.

How should this page be updated?
Remove link to gpu miner binary. Can leave the instructions on how to create a flight sheet, we just can't host the actual link.

[Docs] Update Docs on location for ETXs

As a user, I want to read the docs wrt the location addresses, so that I understand how transactions across zones are recorded.

AC1: Docs include information on how the origin chain bytes are recorded on the transaction, and what that means.

Judi's Gitbook changes

• Run through JSON-RPC API Spec to make sure it matches Gitbook
• Port over new changes from smart contract tutorials (made today)

📝SDK Libraries

What is the title of your proposed page?
SDK Libraries

Does this proposed page solve an existing problem with the docs? Please describe.
Adds general explanation and spec for the quais.js SDK to the docs

Where would this page fit in the existing docs hierarchy?
Under the APIs section in the develop tab

What content goes on your proposed page?
A general overview of quais, how it differs from ethers, and some of the available methods and partner packages

🔗[https://qu.ai/docs/develop/tutorials/multi-chain.md/] In Smart Contracts/ Deploy Page

Where is the broken link?
Page: (Smart Contracts/ Deploy)
Lines: (lines 38-39)

What word(s) is/are incorrectly linked?
Please paste the word or section of copy that is incorrectly linked.

What is the CURRENT, broken link address you are directed to?
https://qu.ai/docs/develop/tutorials/multi-chain.md/

What is the CORRECT, updated link address you should have been directed to (If you don't know, put IDK)?
IDK

Is there any additional context that may be useful in resolving this issue?
I think the link is correct but the page is broken

Zapier Testing issue

Sample dApp Tutorial

Update tutorial in archive and put live under develop tab.

Add search functionality

https://docusaurus.io/docs/search

Test Issue 3