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

Feature request #47

Open
1 of 2 tasks
oxatik opened this issue Nov 16, 2024 · 0 comments
Open
1 of 2 tasks

Feature request #47

oxatik opened this issue Nov 16, 2024 · 0 comments

Comments

@oxatik
Copy link

oxatik commented Nov 16, 2024

Is your feature request related to a problem? Please describe.

Suggestions for Improving Artela Documentation

Describe the solution you'd like

  1. Expand the "Developer" section:

    • Add more detailed guides on running nodes and becoming validators
    • Include step-by-step instructions for deploying dApps on Artela
  2. Improve the "Core Concepts" section:

    • Add diagrams illustrating key concepts like Aspect modules and WASM integration
    • Create interactive quizzes to reinforce understanding of fundamental ideas
  3. Enhance the "Aspect" section:

    • Provide more comprehensive examples of Aspect use cases
    • Include a tutorial on writing custom Aspects
  4. Update the "Join the community" section:

    • Add links to recent community events and meetups
    • Include guidelines for newcomers to the Artela community
  5. Improve code readability:

    • Standardize code formatting across all examples
    • Add inline comments explaining complex logic in code snippets
  6. Add a "Troubleshooting Guide":

    • Compile common issues and solutions encountered during development
    • Include tips for optimizing performance and debugging

Describe alternatives you've considered

As a developer interested in contributing to the Artela ecosystem, I've noticed several areas where the documentation could be improved. These suggestions aim to enhance the overall user experience and make it easier for developers to integrate with Artela.

Additional context

I'd be happy to contribute to implementing these improvements. Please let me know if you'd like me to elaborate on any of these suggestions or if you have additional areas you're considering for enhancement.

Would you like to work on this issue?

  • Yes
  • No
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant