conflux-chain / conflux-documentation Goto Github PK

Describe the feature or improvement
A guide about how to verify an eSpace Contract.

I wrote a guide about Verifying Smart Contracts in Conflux eSpace. I'd like to recheck it and then publish in the eSpace/learn/tutorials section.

Affected page(s) or section(s)
https://doc.confluxnetwork.org/docs/espace/learn/tutorials/verify_smart_contracts

Why is this feature or improvement important?
I wrote the guide because some devs were asking me a lot about how they can get their SC verified. So I think is cool to have this guide (I need to re check the guide to improve it before) in the new dev docs site.

• I'd be willing to contribute this feature myself

Describe the issue 描述问题
Time duration info in this page is outdated

Affected page(s) or section(s) 受影响的页面
https://doc.confluxnetwork.org/docs/core/build/json-rpc/pos_rpc/

• I'd be willing to fix this issue myself. 我将自己修复这个问题。

The writing of transaction stage page needs improving

example

https://ethereum.org/en/developers/docs/

Describe the feature or improvement 描述新特性或改进
Core Space is more clear than just 'Core'

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进

Affected page(s) or section(s) 受影响的页面
Please provide the URL(s) or the section(s) of the documentation where the feature or improvement would be relevant.

Why is this feature or improvement important? 为什么需要这个新特性或改进？
Explain why this feature or improvement would benefit the documentation and its users.

Optional: Implementation ideas 可选：如何实现
If you have any ideas on how to implement this feature or improvement, please provide them here.

Optional: Additional context：可选：其他上下文信息
Add any other context, screenshots, or relevant information about the feature or improvement.

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the issue 描述问题
Some of the descriptions in core JSON-RPC page are from that of eth. We need to fix the inpropriate descriptions.

Affected page(s) or section(s) 受影响的页面
cfx Namespace, e.g. geth client, uncle blocks, etc

• I'd be willing to fix this issue myself. 我将自己修复这个问题。

Ref #39

Describe the feature or improvement 描述新特性或改进
Sidebar default open will easy to find

Describe the feature or improvement 描述新特性或改进
Enrich param control page using CIP-94 information

Affected page(s) or section(s) 受影响的页面
internal contracts/param control

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement
Recently conflux-rust releases have introduced the filter-related API RPC methods, and some other misc updates

Describe the feature or improvement 描述新特性或改进
Add more contents and check translation for glossary page in Crowdin

Affected page(s) or section(s) 受影响的页面
general/../glossary

Why is this feature or improvement important? 为什么需要这个新特性或改进？
The glossary page would serve as an index page for those who are not familiar with Conflux. And besides, there is not a universal translation guide for Conflux terms.

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

#24

Describe the feature or improvement 描述新特性或改进
https://doc.confluxnetwork.org/docs/general/tutorials/transferring-funds/from-exchanges/okx
Links are missing for the page

Affected page(s) or section(s) 受影响的页面
Please provide the URL(s) or the section(s) of the documentation where the feature or improvement would be relevant.

Why is this feature or improvement important? 为什么需要这个新特性或改进？
Explain why this feature or improvement would benefit the documentation and its users.

Optional: Implementation ideas 可选：如何实现
If you have any ideas on how to implement this feature or improvement, please provide them here.

Optional: Additional context：可选：其他上下文信息
Add any other context, screenshots, or relevant information about the feature or improvement.

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进

Add tutorial for how to pay for Confura key

Affected page(s) or section(s) 受影响的页面

• a new page in general/tutorials (named general/tutorials/conflux-paywall or any other related name)
• add links in network endpoints page(both core and espace)

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the issue 描述问题
PoS finalization is accelerated according to CIP-113

Affected page(s) or section(s) 受影响的页面
Please provide the URL(s) or the section(s) of the documentation affected by the issue.

• I'd be willing to fix this issue myself. 我将自己修复这个问题。

Describe the issue 描述问题
With the introduction of CIP-107, sponsorship page is supposed to update

Affected page(s) or section(s) 受影响的页面
Please provide the URL(s) or the section(s) of the documentation affected by the issue.

Optional: Suggested solution 可选：如何解决
If you have a suggested solution or correction, please provide it here.

Optional: Additional context 可选：问题上下文信息
Add any other context, screenshots, or relevant information about the issue.

• I'd be willing to fix this issue myself. 我将自己修复这个问题。

Why is this feature or improvement important? 为什么需要这个新特性或改进？

The old version of the document is outdated and has increased the burden on developers in searching for documentation, leading to confusion.

Optional: Implementation ideas 可选：如何实现

1. Make sure the new doc site is well-organized and easy to find doc
2. Offline the old one
3. Redirect the old domain to the new

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进

Add SDK tutorials for eSpace developers

Affected page(s) or section(s) 受影响的页面

a new page in espace/build/... page

Why is this feature or improvement important? 为什么需要这个新特性或改进？

Though Conflux eSapce is fully compatible with EVM, only EIP-155 transactions are accepted. However, the ethereum SDKs tend to adopt EIP-1559 as the default encoding approach so it still require developers to add extra settings to their code in order to construct legacy transactions

Optional: Implementation ideas 可选：如何实现

List how to construct legacy ethereum transactions documents for popular ethererum libraries.

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进

The running node pages need updating and a lot of important information is missed (for example, the snapshot usage, etc). We should make sure it is possible everyone can start a node through the tutorial.

Affected page(s) or section(s) 受影响的页面

General/Run a Node/...

Why is this feature or improvement important? 为什么需要这个新特性或改进？
Explain why this feature or improvement would benefit the documentation and its users.

Optional: Implementation ideas 可选：如何实现
If you have any ideas on how to implement this feature or improvement, please provide them here.

Optional: Additional context：可选：其他上下文信息
Add any other context, screenshots, or relevant information about the feature or improvement.

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进
Currently the logo of the website is not responsive. It shall change in dark mode

Affected page(s) or section(s) 受影响的页面
Any

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进
Add more content and useful link to home page of documentation site

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进
Documents for new RPC API trace_epoch

Affected page(s) or section(s) 受影响的页面
core/build/.../trace_namespace

Optional: Additional context：可选：其他上下文信息

https://forum.conflux.fun/t/conflux-hydra-network-v2-2-4-upgrade-announcement/18611

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

• http://doc.confluxnetwork.org/docs/core/learn/core-space-basics/internal-contracts/params-control
• https://github.com/Conflux-Chain/conflux-rust/blob/master/internal_contract/contracts/ParamsControl.sol
  new method posStakeForVotes is added

Currently, link -> description field in _category_.json is the default string 5 minutes to learn the most important Docusaurus concepts. We need to change it to proper ones

Describe the feature or improvement 描述新特性或改进
Currently, it is not easy to find the developer site entry in confluxnetwork.org, it's better to add one item in the top menu and footer, which is easy to use

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the issue 描述问题
PoW reward has changed to 1 CFX now, these page info need to be update: https://doc.confluxnetwork.org/docs/general/conflux-basics/economics#cfx-annual-inflation

Describe the feature or improvement 描述新特性或改进
Add ulimit -n 10000 back to Node Documents

Affected page(s) or section(s) 受影响的页面
Node running pages

Why is this feature or improvement important? 为什么需要这个新特性或改进？
This sentence is somehow missed during migration

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进
Provide more detailed wallet choice information in tutorial pages.

Affected page(s) or section(s) 受影响的页面
Core/eSpace tutorial pages

Why is this feature or improvement important? 为什么需要这个新特性或改进？
Currently in certain pages in tutorials, the wallet recommendation is fixed to Metamask in eSpace. It is ok but at least we need to mention the fluent choice

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

current JSON-RPC page's style is not good

Describe the feature or improvement
Currently the .sol interfaces of several internal contract pages are missed.
Add .sol interfaces to internal contracts

• I'd be willing to contribute this feature myself

Currently, the menu sidebar is folded, and it is not easy to quickly read all doc titles, if an independent menu page is provided that could improve the efficiency of finding a doc.

The writing of transaction explanation article needs improvement

Enrich espace-introduction page. A short introduction of how it interacts with core space is expected to be mentioned

Fluent has set up its documentation site, add a link to it for quick access.
https://docs.fluentwallet.com/conflux/

Replace the old links (starting with https://develper....) to new ones

Describe the feature or improvement 描述新特性或改进
Currently DAO Vote descriptions are missed in Economics page

Affected page(s) or section(s) 受影响的页面
https://doc.confluxnetwork.org/docs/general/conflux-basics/economics/

Why is this feature or improvement important? 为什么需要这个新特性或改进？
DAO Vote will determine the reward from PoS/PoW

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the feature or improvement 描述新特性或改进
Integrate https://github.com/conflux-fans/conflux-faqs/blob/main/community-faq.md into general/faq

Affected page(s) or section(s) 受影响的页面
general/faq

• I'd be willing to contribute this feature myself. 我将自己实现这个feature

Describe the issue 描述问题
There is sentence that refers to something that is not on the documentation.
23 "All the times stated below are corresponding to the number of blocks."

Affected page(s) or section(s) 受影响的页面
docs/general/conflux-basics/consensus-mechanisms/proof-of-stake/pos_overview.md
23
Just before PoS Account section.

Optional: Suggested solution 可选：如何解决
Delete the sentence "All the times stated below are corresponding to the number of **blocks." from line 23.

• I'd be willing to fix this issue myself. 我将自己修复这个问题。

It will be easier to find documentation if we have a search bar

Describe the issue 描述问题
Confura's rate limits are going to update. Update explanation in network endpoints pages to new one.

Affected page(s) or section(s) 受影响的页面
core/espace network endpoint page

Optional: Additional context 可选：问题上下文信息
https://forum.conflux.fun/t/announcement-confura-and-scan-open-api-restrictions-and-fees/18287

• I'd be willing to fix this issue myself. 我将自己修复这个问题。

https://wiki.conflux123.xyz/books/run-conflux-node/page/conflux