Skip to content

docs: converter readme#8

Merged
fmorency merged 1 commit intomanifest-network:mainfrom
fmorency:readme-convert
Sep 26, 2025
Merged

docs: converter readme#8
fmorency merged 1 commit intomanifest-network:mainfrom
fmorency:readme-convert

Conversation

@fmorency
Copy link
Contributor

This pull request adds comprehensive documentation for the Converter contract in the Manifest Network repository. The new README.md provides an overview of the contract's functionality, architecture, and usage, making it easier for developers and users to understand and interact with the contract.

Documentation improvements:

  • Added an overview section describing the Converter contract's purpose and features, including token conversion, configurable exchange rates, pause functionality, and admin controls.
  • Detailed the contract architecture, outlining key components such as the rate system, denomination management, admin controls, and conversion logic.
  • Provided example messages for contract instantiation, execution (convert, update config, update admin), and queries (config, admin), with JSON samples for clarity.
  • Included development instructions for building and testing the contract, as well as migration and licensing information.
  • Added relevant links to the repository and homepage for further reference.

@fmorency fmorency requested a review from Copilot September 26, 2025 16:58
@fmorency fmorency self-assigned this Sep 26, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds comprehensive documentation for the Converter contract by creating a new README.md file. The documentation provides essential information about the contract's purpose, features, architecture, and usage patterns for developers and users.

  • Created comprehensive README.md documentation for the Converter contract
  • Documented contract functionality including token conversion, exchange rates, and admin controls
  • Added example JSON messages for instantiation, execution, and queries

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@codecov
Copy link

codecov bot commented Sep 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fmorency fmorency merged commit 056c63f into manifest-network:main Sep 26, 2025
5 checks passed
@fmorency fmorency deleted the readme-convert branch September 26, 2025 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants