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

Include docs #223

Merged
merged 8 commits into from
Sep 6, 2024
Merged

Include docs #223

merged 8 commits into from
Sep 6, 2024

Conversation

Moliholy
Copy link
Collaborator

@Moliholy Moliholy commented Sep 3, 2024

This PR adds documentation about the Mythos parachain.

- **Description**: A proxy module that allows account delegation.
- **Functionality**: Enhances security and resource management by enabling accounts to delegate tasks to other accounts.


Copy link
Collaborator

Choose a reason for hiding this comment

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

We should add sections for:

  1. AccountId20 support and how that is implemented with reference to relevant files.
  2. XCM Config used and some context on that.
  3. Benchmarking hardware used.
  4. Consensus details - collator selection and aura.
  5. Finality and average time to finality.

If there is anything else.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I just added it. Please, let me know if that's sufficient or should be further extended.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should expand a bit more and link to the relevant files/sections in the code.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I just expanded that section and included links to the relevant sources.

@valentinfernandez1
Copy link
Collaborator

Just added some extra information about zombient and benchmarking and unified formatting using prettier

@@ -45,15 +43,20 @@ To bootstrap a local instance of the blockchain, use the script [./zombienet.sh]

### Mainnet - Mythos local network.
./zombienet.sh mainnet

### Testnet - Muse local network and AssetHub Parachain connected via HRMP channel.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

HRMP channels have to be manually created using ./scripts/hrmp-helper.sh. That's why I excluded this one and the corresponding mainnet one. Simply in order not to overcomplicate the documentation.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh yes you are right, I forgot about that one. We can add it in a concise way, let me rewrite it

@gautamdhameja gautamdhameja self-requested a review September 6, 2024 12:14
@Moliholy Moliholy merged commit f57eaca into main Sep 6, 2024
4 checks passed
@Moliholy Moliholy deleted the update-docs branch September 6, 2024 12:14
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.

3 participants