Skip to main content

DevDocs Contribution

Welcome to the Aleo DevDocs contribution guide! We invite you to help improve our documentation, making it more comprehensive and up-to-date. Your contributions, big or small, are valuable in enhancing the Aleo ecosystem for developers. This guide will walk you through the process of contributing effectively to our documentation.

Providing Feedback​

If you've found an issue or have a suggestion for improvement but don't have time to make the changes yourself, you can still contribute by providing feedback through GitHub Issues:

  1. Go to the Issues page of the welcome repository.
  2. Click on "New Issue".
  3. Choose the appropriate issue template if available, or start with a blank issue.
  4. Provide a clear and concise title that summarizes the issue or suggestion.
  5. In the description:
    • For bugs or errors: Describe what you expected to see and what you actually saw. Include steps to reproduce if applicable.
    • For improvement suggestions: Explain your idea and how it would enhance the documentation.
    • If relevant, include screenshots or code snippets to illustrate your point.
  6. Add appropriate labels to your issue (e.g., "documentation", "enhancement", "bug").
  7. Submit the issue.

Your feedback helps us identify areas for improvement and ensures the documentation remains accurate and helpful for all users.

Getting Started​

  1. Fork the welcome repository on GitHub.

  2. Clone your forked repository locally:

    git clone https://github.com/YOUR-USERNAME/welcome.git

  3. Navigate to the project directory:

    cd welcome

  4. Make changes in the documentation directory:

    cd documentation

    This is where you'll find the content files to edit.

Making Changes​

  1. Create a new branch for your changes:
    git checkout -b your-feature-branch
  2. Make your changes to the documentation files. Most content is in Markdown format.
  3. Commit your changes with a descriptive commit message:
    git commit -am "Add description of your changes"

Submitting Your Contribution​

  1. Push your changes to your forked repository:
    git push origin your-feature-branch
  2. Go to the welcome repository on GitHub and create a new pull request from your-feature-branch.
  3. Provide a clear title and description for your pull request, explaining the changes you've made.
  4. Submit the pull request for review.

Guidelines​

  • Ensure your writing is clear, concise, and follows the existing style of the documentation.
  • Use proper Markdown formatting for headings, code blocks, and other elements.
  • If adding new pages, update the sidebar configuration appropriately.
  • Include any necessary images or diagrams to illustrate concepts.
  • Verify all links are correct and working.

Need Help?​

If you have any questions or need assistance, please don't hesitate to open an issue in the welcome repository or reach out to the maintainers.

Thank you for contributing to the Aleo documentation!