Proposal Overview
Recently, we submitted an on-chain proposal here to revamp and enhance the documentation, but it did not pass due to insufficient prior discussions with the Axelar team and other stakeholders. In response, @Ben_Weinberg organized a meeting here to address this issue and align our efforts, acknowledging the critical importance of this initiative within the ecosystem.
During this initial meeting, attended by Marty & @Ben_Weinberg from Axelar, we conducted a comprehensive review of our proposal. We discussed our approach in detail, considered the Axelar team’s feedback, and reached a consensus on several key aspects outlined in our initial submission.
Following this, we held a subsequent meeting with Marty and @StephenFluin , where we further examined the urgency and necessity of improving the documentation. This additional discussion underscored the need for a structured and phased approach. As a result, we refined our proposal to include specific deliverables and timelines, dividing the project into three phases to strengthen the proposal for resubmission.
We extend our sincere thanks to Ben, Marty, and Stephen for their invaluable guidance and support throughout this process. After multiple thorough meetings and discussions, we have reached this final, refined proposal, which includes detailed explanations, deliverables, and a clear timeline.
Introduction
We propose a three phased comprehensive revamp and improvement of the Axelar Network documentation with cutting-edge features and enhancements. Our proposal addresses the current documentation’s issues, ranging from UI/UX improvements to better search functionality, proper guidelines for community contributions, better maintainable code, high responsiveness, and improved text/content, video tutorials and infographics wherever applicable.
Impact
Improving the documentation will make a huge difference for everyone involved. New users will find it easier to get started, and experienced contributors will appreciate the clear, organized information. The advanced search function will help everyone find what they need quickly. Plus, with better onboarding materials and an open invitation for contributions, we’ll foster a stronger, more engaged community. These changes will support growth for the entire ecosystem.
Deliverables and Goals to be achieved across Three Phases
Here are the key deliverables and goals we plan to accomplish to enhance the Axelar documentation and user experience:
Redesigned and Fixing User Interface and Overall Layout: Revamp the UI/UX to align with Axelar’s updated brand identity, incorporating the latest branding elements and design language to closely match the newly revamped main site.
Fully Responsive Site for All Devices: Ensure the documentation site is fully responsive, providing a seamless experience across all devices, from desktops to smartphones.
Simplified and Streamlined Navigation: Simplify and streamline navigation, implementing best UX practices for improved usability and user experience.
Brand Alignment: The documentation site’s branding will be updated to reflect Axelar’s new identity, with proper alignments and UX practices to enhance the overall look and functionality.
Here are some examples of the UI/UX issues that we found (Note that these preliminary designs were made just to point out major mistakes and not keeping in mind the Axelar brand revamp. These are just for reference and wont be used as new designs will reflect the new brand identity):
Some possible solutions:
Ps. These are just a few major problems that we have pointed out, more thorough research is required to make the documentation site as good as possible. The solutions proposed are also preliminary.
2. Quality Code and Community Guidelines
- High-Quality, Maintainable Code:
- Ensure the codebase is clean, efficient, and easy to maintain.
- Comprehensive Community Guidelines:
- Provide clear and detailed guidelines to help contributors understand how to contribute effectively.
- Onboarding Materials and Tutorials for Contributors:
- Create helpful resources and tutorials to make it easy for new contributors to get started.
3. Improved Algolia Search Functionality and New Landing Page
- Algolia-Powered Search Improvements:
- Enhance Algolia for a fast and accurate search experience.
- Improved Search Accuracy and Relevance:
- Fine-tune search algorithms to deliver more relevant results.
- Advanced Search Filters:
- Add filters to help users narrow down their search results.
- New Landing Page with updated Axelar Brand Image:
- Design a new landing page that provides quick access to the most important sections and pages, keeping in mind the updated Axelar brand image.
4. Text/Content Improvements and Guided Graphics
- Informative and Relevant Guided Graphics:
- Use graphics that are both informative and relevant to the content, enhancing understanding.
- Refined, Clear, and Consistent Textual Content:
- Ensure the text is clear, concise, and consistently presented.
- Identify and Improve Confusing Text:
- Find and clarify any confusing or ambiguous text.
- Detailed Guides for Beginners:
- Create step-by-step guides specifically designed to help beginners understand and use the content effectively.
5. A New Dedicated “Getting Started” Section
- Step-by-Step Guides: Provide clear, concise guides to help new users get started quickly.
- Interactive Tutorials: Offer interactive tutorials to walk users through essential tasks.
- Helpful Resources: Include links and components to additional resources for further assistance.
6. Video Tutorials
- Dedicated Video Tutorials for CLI and Proposals:
- Provide specific tutorials on how to get started with the CLI and how to push proposals on the chain.
- identify other areas where a video tutorial will be beneficial and create them.
7. Extended Documentation Integration
- Integration of CLI and Proto Docs:
- Incorporate the extended documentation for CLI and Proto, currently only on GitHub, into the main documentation website. This will be done by consulting the core team, bringing the most relevant and frequently used cli and proto docs to the main website.
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
- TypeScript
- TAILWIND CSS
- REACT COMPONENTS
- MARKDOWN
Phase 1: Design and Development, UI/UX Overhaul, New Landing Page and Initial Setup (6 Weeks, 300 hrs)
This phase will focus on aligning the documentation site with Axelar’s newly revamped main website to ensure a cohesive brand identity. We’ll start with a documentation audit, followed by developing and implementing new designs. Key activities and deliverables include:
-
Kickoff Meetings: Align with the Axelar team on goals and the vision for the documentation site.
-
Documentation Audit: Review existing content to ensure consistency with the new design language.
-
Design Development: Create and implement fresh, visually appealing designs, including a new landing page, that reflect Axelar’s updated brand identity.
-
UI/UX Overhaul: Improve navigation, accessibility, and overall user experience across all devices.
-
Fixing Dead Links: We have found multiple dead links(over 100+) in the docs, which will be fixed.
Detailed Timeline: 6 weeks
Week 1: Initial Setup and Planning
- Kickoff Meeting: Align on goals, expectations, and the vision for the revamped site.
- Documentation Audit: Review existing documentation for strengths and areas needing improvement.
- UI/UX Discussions: Finalize the vision for the new design, ensuring alignment with Axelar’s brand.
Weeks 2-3: UI/UX Design and Prototyping
- Design the New Landing Page: Create a design that reflects the new identity and offers easy navigation.
- UI Redesign: Develop prototypes for the revamped user interface, focusing on layout, aesthetics, and responsiveness.
- Feedback and Iterations: Gather initial feedback on designs and make necessary adjustments.
Weeks 4-5: Development and Implementation
- Code the New Designs: Implement the approved designs into the documentation site.
- Navigation and Responsiveness: Ensure the new design is functional and responsive across all devices.
- Fixing dead links: The dead links issue will be fixed by the end of 5th week as well, ensuring all links in the documentation are relevant and working.
Week 6: Final Review and Adjustments
- Review and Testing: Conduct a thorough review of the implemented changes, ensuring all elements are aligned with the new identity.
- Feedback and Final Touches: Make final adjustments based on team feedback.
- Preparation for Phase 2: Ensure a smooth transition to the next phase with all foundational elements in place.
By the end of this phase, the documentation site will have a modern look that aligns with Axelar’s brand and enhances the user experience. This will attract many new contributors and users in the ecosystem.
Phase 2: Implementation of “Getting Started” Section, Improving Search Functionality, and Community Guidelines (3 weeks, 150 hrs)
In this phase, we’ll focus on enhancing the content and usability of the site. We’ll introduce a comprehensive “Getting Started” section, improve search functionality, and establish clear community guidelines. The tasks include:
- “Getting Started” Section: Develop a user-friendly section with detailed guides and tutorials to assist new users in navigating the platform.
- Search Functionality Enhancement: Improve the Algolia-powered search implementation for faster and more accurate results, along with advanced filters to help users find what they need more efficiently. Plus saving recent searches for better suggestions as well.
- Community Guidelines and Onboarding Materials: Create and publish detailed community guidelines and onboarding materials to assist new contributors in understanding the contribution process and standards.
Detailed Timeline: 3 weeks
Week 1:
- Develop “Getting Started” Section:
- Design and structure the “Getting Started” section.
- Create detailed guides and tutorials to assist new users.
Week 2:
- Enhance the Algolia Search Functionality:
- Optimize the Algolia-powered search for faster and more accurate results.
- Implement advanced filters to refine search outcomes.
- Add features like saving recent searches to improve search suggestions.
Week 3:
- Create Community Guidelines and Onboarding Materials:
- Develop comprehensive community guidelines.
- Design onboarding materials to guide new contributors.
- Publish and integrate these resources into the site.
By the end of this phase, the documentation site will offer improved usability with a robust “Getting Started” section, enhanced search capabilities, and clear community guidelines. We would also be reviewing all contributions and aim to encourage active contributions from community members.
Phase 3: Extended Document Integration, Video Tutorials, and Final Refinements (3 weeks, 150 hrs)
The final phase focuses on integrating all elements, conducting a thorough audit, and preparing the site for final release. The tasks include:
- Final Documentation Audit and Refinement: Review all content for accuracy especially the new guides which have been produced for the final time with the team. Add any new content if needed.
- Extended Documentation Integration: Incorporate key CLI and Proto docs from GitHub, along with guides and video tutorials for common issues and frequently used commands, based on core team input.
- Video Tutorials: Create and embed video tutorials for key tasks like using the CLI and pushing proposals on the chain, along with other identified areas.
- Feedback and Adjustments: Collect feedback from the Axelar team and community, making any necessary refinements before the final launch.
- Final Handoff: Ensuring all resources are handed over to the Axelar team for ongoing maintenance and updates.
Detailed Timeline: 3 Weeks
Week 1
- Final Documentation Audit and Refinement: Review and refine all content, including new guides which have been produced. Incorporate any additional updates or create new guides or tutorials if needed.
Week 2
- Extended Documentation Integration & Video Tutorials: Integrate key CLI and Proto docs from GitHub, and embed video tutorials for essential tasks like using the CLI and pushing proposals on the chain, along with other identified areas.
Week 3
- Feedback and Adjustments: Collect feedback, make necessary adjustments, and prepare for the final handoff. Complete the handoff to the Axelar team for ongoing maintenance and updates.
Overall Timeline & Budget
The proposal is divided into three phases as outlined above. The total estimated time for complete implementation and improvements is up to 12 weeks, requiring over 600 hours of high-quality, dedicated efforts as detailed in the requirements. Our ability to execute is demonstrated by the past work listed in the proposal below. We request $60k in AXL tokens to be requested in phases , based on 600 hours of work at an hourly rate of $100, totaling $60,000.
To ensure a structured and effective implementation, we will submit an on-chain proposal requesting funding specifically for Phase 1. Upon successful completion of Phase 1, we will follow up with additional proposals for Phases 2 and 3. This phased approach will allow us to demonstrate progress and make necessary adjustments based on the outcomes of each phase.
Funding Request
- Phase 1: $30k
- Phase 2: $15k
- Phase 3: $15k
The total requested budget is $60k, to be allocated across the three phases.
Governance Timeline
- 10th Aug: Community Forum Discussion Update
- 12th Aug: Voting live, the short discussion timeline is due to already extensive discussion and feedback in past proposal and on-chain vote
- 14th: 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 12 weeks as explained in the proposal, with regular weekly updates shared with the community and ecosystem.
Motivation
When we first started with Axelar, we encountered numerous challenges with the documentation. It was difficult to find the information we needed, and many sections were unclear. We don’t want any newcomers to feel that same way, and we want experienced users to easily find everything they need and have a productive, clear experience. Our goal is to create streamlined, well-written documentation with a great user experience. We want to make sure that anyone new to Axelar finds it approachable and easy to navigate. By improving the documentation, we hope to foster a welcoming environment that encourages learning and participation.
Bio & Past Work
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.
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. Here are the GitHub links for our two relevant recent projects:
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.
We ask for the community’s support during the vote and invite any questions related to the proposal or any other concerns below.
Thank you