Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: documentation #18

Merged
merged 21 commits into from
Mar 25, 2024
Merged

chore: documentation #18

merged 21 commits into from
Mar 25, 2024

Conversation

chalabi2
Copy link
Collaborator

Added contributing doc
Added Repo Readme
Added Security Doc
Updated Post Genesis Guide
Began POA_Guide

Description

Added more documentation. Readme descriibng the repo and features, Security contact details, contribution guidelines and updated the post genesis guide.
This pull request is not finished we still need:

  • Security contact & optional PGP key
  • Update the PR guidelines in contribution doc
  • add security contact email in contributing and security
  • Multisig docs and potential script to assist

Checklist:

  • I have read and followed the CONTRIBUTING guidelines for this project.
  • I have added or updated tests and they pass.
  • I have added or updated documentation and it is accurate.
  • I have noted any breaking changes in this module or downstream modules.

Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (main@e2635fa). Click here to learn what that means.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #18   +/-   ##
=======================================
  Coverage        ?   18.59%           
=======================================
  Files           ?       39           
  Lines           ?     6826           
  Branches        ?        0           
=======================================
  Hits            ?     1269           
  Misses          ?     5446           
  Partials        ?      111           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@chalabi2 chalabi2 added the documentation Improvements or additions to documentation label Mar 15, 2024
Copy link
Collaborator

@fmorency fmorency left a comment

Choose a reason for hiding this comment

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

Thank you for this. Here's my first round of comments.

I will try to join the testnet next.

network/manifest-1/README.md Outdated Show resolved Hide resolved
MODULE.md Outdated Show resolved Hide resolved
MODULE.md Outdated Show resolved Hide resolved
MODULE.md Outdated Show resolved Hide resolved
MODULE.md Outdated Show resolved Hide resolved
network/manifest-1/POST_GENESIS.md Outdated Show resolved Hide resolved
network/manifest-1/README.md Show resolved Hide resolved
network/manifest-1/README.md Show resolved Hide resolved
network/manifest-1/README.md Show resolved Hide resolved
network/manifest-1/README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Collaborator

@fmorency fmorency left a comment

Choose a reason for hiding this comment

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

Can you also document what can be queried, i.e., using manifestd q manifest?

@fmorency
Copy link
Collaborator

@chalabi2 @Reecepbcups is this PR ready for re-review/merge?

@fmorency fmorency mentioned this pull request Mar 25, 2024
@Reecepbcups
Copy link
Collaborator

@fmorency yes. The things I did not reply too are because I don't quite understand the need, chalabi probably knows more / better such as #18 (comment)

README.md Outdated Show resolved Hide resolved
@chalabi2 chalabi2 requested a review from fmorency March 25, 2024 19:47
@@ -234,10 +234,12 @@ The Token Factory module as it is implemented on the Manifest Network, allows an

- Syntax: `manifestd tx token-factory create-denom [subdenom]`

- Parameters:
- `subdenom`: The smallest denomination for your token e.g. udenom.
> _note:_ the createor of the denom is the denoms admin.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
> _note:_ the createor of the denom is the denoms admin.
> _note:_ the creator of the denom is the denom admin.

@fmorency fmorency merged commit ef4fc76 into main Mar 25, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants