mountcount/conflux-documentation

Documentation for Conflux Network. Alternative mirror https://confluxdocs.com

Conflux Developer Portal

This repo provides documents for conflux-rust.

Deployments:

• https://doc.confluxnetwork.org/
• https://www.confluxdocs.com/

Repo Structure

• docs: contains the original doc contents (in English)
  • docs/templates: special folder served as template for reuse, aimed for creating similar articles in eSpace and bSpace. The eSpace User Guide serves as an example to show how to replace texts, links and images.
• i18n: contains the localized doc contents. Note: the contents are added by the translation platform Crowdin. NEVER directly edit the content in this file to edit the translation
• scripts: contains scripts used for automation
• docusaurus.config.js: the configuration file for docusaurus
• sidebar.js: the sidebar configuration, used by docusaurus.config.js

Contributing

How to Contribute

We welcome contributions in a variety of forms, including but not limited to:

1. Pointing out a mistake/typo and (optionally) providing a solution
2. Providing translation
3. Creating or improving diagrams, charts, or visual aids
4. Suggesting improvements to the documentation structure or organization
5. Writing or updating a tutorial or guide
6. Creating or updating code samples, examples, or demos
7. Polishing or improving document writing

To make a contribution, please take one of the following actions:

• Report an Issue: If you spot a problem or is willing to suggest improvements, create an issue to let us know. You can also directly submit the issue via our Conflux Documentation Issue Form.
• Submit Changes: For direct contributions to content, create a pull request.
• Help with Translation: To contribute translations, please follow our translation guidelines.

Contributor Rewards and POAPs

We distribute FansCoin (FC) rewards and issue POAPs for our contributor as appreciation. For the reward guidelines and contributors POAPs to learn how the tokens are distributed.