Proposal to Revamp and Improve Axelar Network Documentation

Governance and Grants
1

Proposal to Revamp and Improve Axelar Network Documentation

Who We Are

At Hooman Digital, we are a dynamic team of versatile professionals with expertise across various digital domains. Our commitment is to deliver authentic and user-friendly solutions tailored to meet the unique requirements of Decentralized Autonomous Organizations (DAOs). Our diverse team includes designers, developers, writers, marketers, and community builders, all working in unison to create seamless digital experiences.

A testament to our capabilities is our successful collaboration with Akash Network, where we designed, developed and currently maintain their 100% open-source website, highlighting our dedication to transparency and community-driven development. Additionally, we have built a cutting-edge platform for ArbitrumDAO (currently in progress), aimed at being a universal hub to enhance information access within the Arbitrum ecosystem.

Introduction

We propose a comprehensive revamp and improvement of the Axelar Network documentation with cutting-edge features and enhancements. Our proposal will address the current documentation’s issues, ranging from UI/UX improvements to better search functionality, proper guidelines for community contributions, high responsiveness, and improved text and infographics wherever applicable.

Proposed Tasks

Our tasks are divided into four primary workflows:

  1. UI and UX Design Improvements with Proper Responsiveness

    • Redesign the user interface: Create a visually appealing and intuitive interface that aligns with Axelar’s brand identity.
    • Enhance responsiveness: Ensure the documentation site is fully responsive and provides an optimal user experience across all devices and screen sizes.
    • Improve navigation: Simplify and streamline the navigation structure to help users find information quickly and easily.

  2. Quality Code with Proper Community Guidelines

    • Develop high-quality, maintainable code: Follow best practices in coding standards to ensure the documentation is robust, scalable, and easy to maintain.
    • Create comprehensive community guidelines: Provide clear, detailed guidelines to help new contributors get started easily and ensure consistency in contributions.
    • Facilitate easy onboarding: Develop onboarding materials and tutorials to assist community members in contributing effectively.

  3. Improved and High-Quality Search Functionality

    • Implement Algolia-powered search: Integrate Algolia to provide fast, accurate, and relevant search results for users.
    • Enhance search accuracy: Optimize search algorithms to ensure users can find the exact information they need quickly.
    • Add search filters: Implement advanced search filters to allow users to refine their search results based on various criteria.

  4. Infographics and Text Improvements

    • Develop informative infographics: Create visual aids to enhance understanding of complex concepts and processes within the documentation.
    • Refine textual content: Improve the clarity, readability, and conciseness of the existing text to make it more user-friendly.
    • Ensure consistency and accuracy: Regularly review and update content to maintain accuracy and ensure consistency in terminology and style.

Why We Are the Best for This Task

We have contributed significantly to other blockchain networks and possess the expertise required to seamlessly handle these tasks. Notably, in the Cosmos ecosystem, we revamped the entire Akash Network site, including documentation, as a 100% open-source initiative, which has attracted extensive community contributions.

Tech Stack

We will adhere to the existing tech stack used by Axelar Network, ensuring better code quality and implementation. Our proposed tech stack includes:

  • AstroJS
  • TAILWIND CSS
  • REACT COMPONENTS
  • MARKDOWN
  • OPEN-SOURCE

Budget and Timeline

We propose to complete this project within 2-3 months, with weekly progress reports and regular meetings to share updates. We request a budget of $60k to start and complete this task. Below is a detailed breakdown of tasks, budget, and timeline:

  1. Blueprints and User Flow (100 hours)

    • Research and plan user flow and structure.
    • Draft the blueprints of the overall documentation.
    • Identify key user personas and tailor the documentation structure to their needs.

  2. UI Design (150 hours)

    • Design the UI for various breakpoints as per the blueprints.
    • Create a consistent visual style that aligns with Axelar’s brand.
    • Design infographics wherever applicable to enhance visual communication.

  3. Development (220 hours)

    • Develop the documentation as per blueprints and design direction.
    • Ensure the documentation is highly responsive and compatible with all devices.
    • Maintain code quality and provide guidelines for community contributions.
    • Implement accessibility features to ensure the documentation is usable by all users.

  4. Improved Search Functionality and Open-Sourcing, Handover (130 hours)

    • Implement advanced search functionality using Algolia.
    • Open-source and hand over the work under an appropriate open-source license.
    • Collaborate with the Axelar team to update and integrate the new documentation site.
    • Provide training and documentation for the Axelar team to manage and update the site.

Total Hours: 600 hours
Budget: 600 hours * $100/hour = $60k

Governance Timeline

  • 8th-15th June 2024: Forum discussions and feedback.
  • 16th June 2024: Submit the proposal on-chain.
  • 23rd June 2024: Proposal result (pass/fail).

If the proposal succeeds on-chain, we will begin work one week after the conclusion of the voting period. The tasks will be completed within 2-3 months, with regular weekly updates shared with the community and ecosystem.

Conclusion

This proposal addresses the need for high-quality documentation for the community, presenting a solid plan with a capable team and the experience to execute the tasks effectively. We request the community’s support to initiate and deliver a superior version of Axelar Network’s documentation as outlined in this proposal.

Thank you for considering our proposal. We look forward to the opportunity to enhance the Axelar Network documentation for the benefit of the entire community.

2

Our proposal is now live for voting on-chain: View Proposal.

We kindly request the community to support our proposal during the voting period. If you have any questions or need further clarification, please feel free to ask below.

Thank you for your support!

3

It seems we are receiving some negative votes from a few major validators.

We would like to emphasize that this proposal addresses a critical aspect of the ecosystem: having well-defined and well-maintained documentation for users and developers.

Currently, the documentation has several issues:

  • The UI/UX is suboptimal.
  • Navigation and search functionality are inadequate.
  • Content and definitions are incomplete or unclear.
  • There is no infographic support to aid understanding.

Our team is fully equipped and has a strong track record of successfully implementing similar projects.

We kindly request the community to support our proposal during the voting period. If you have any questions or need further clarification, please feel free to ask below.

Thank you for your support!

4

$100 per hour for a doc writer seems excessive.

5

Thanks, @walkjivefly, for the feedback. I want to point out that this isn’t just a document writer’s task. It’s a comprehensive process of creating solid documentation that involves developing a proper web app, search functionality, UI/UX design, infographics, and more.

I recommend checking the breakdown defined here for each task:

6

Have you got an example of this kind of “upgrade” you’ve performed for some other chain/protocol?

7

yes, you can check this out here, we have mentioned the proper expertise and past works. We have worked for some big DAOs including Akash Network, Arbitrum etc…

8

I don’t understand the numerous NO votes on our on-chain voting proposal. We have a proven track record and have clearly explained the pain points we aim to address.

If there are concerns or questions about our proposal and expertise, please ask below. We are happy to answer any queries. However, a direct NO vote without any questions or explanation sends a negative signal to contributors like us, who research, identify pain points, draft proposals, and propose on-chain with the hope of making improvements. This process is time-consuming, and we deserve at least an explanation for the NO votes.

Thank you.

9

Additionally, we would like to emphasize that we will not touch the amount we receive as part of this proposal until we have completely delivered and everyone is satisfied with the outcome. We will immediately stake the received amount and will only exercise our authority over it once we have fulfilled our promises.

This is our guarantee and assurance. In the proposal, we have also outlined our expertise and past work. I guarantee that we will exceed expectations.

From now on, we leave the decision to the community and validators. We would love to work wholeheartedly if our proposal passes.

Thank you.

10

Your work seems good on the websites you mentioned, however a $60k budget in order to upgrade a documentation site which is functioning rather well (i did not see any complaint by anyone on it so far) seems a bit excessive, especially when this budget does not include updating the actual content which is the important part of the docs site.

If anything the docs site needs a tech writer to go over it and update all the guides and tutorials which are currently maintained by the Axelar community.

1 Like
11

Thank you for the feedback. We proposed comprehensive improvements, including updates to the text and overall content.

We specifically mentioned updates to the text, incorporating infographics wherever applicable.

If our proposal had been accepted, we were confident it would amaze the community.

However, it seems to have been failing. No worries, at least we tried.

Thank you for the feedback and support

12

Hi @boldpanther thank you for putting forth this initiative! I help write up documentation for Axelar with the Interop Team. I think some of the suggestions you have put forward here to improve the docs are really interesting and could be very beneficial. From our end it would be great if we could schedule some time to discuss how to best move forward here. If you are going to be making significant contributions to the docs going forward, it is best to make sure we’re collaborating as opposed to each of the sides just writing up and editing content without any communication. Happy to schedule sometime to discuss this proposal and your vision for the docs going forward. Here is my calendly, cheers!

1 Like