Roadmap for the Aladdin DAO Website & Docs

Please give feedback on github discussions ↗. I will add the items right here and implement them if makes sense.

Introduction

The aim of this project is initially to facelift the Aladding DAO website and the Documentation, and secondly to create a process and a structure to document and communicate protocol related information to outside world.

Roadmap Items

Feature Parity

MVP

• Add Search Functionality
• Add Mobile Support
• Migrate all docs 1 to 1 from Aladdin DAO Docs ↗
• Find and add Whitepapers for each product.
• Migrate/Create FAQ’s for each product.
• Revisit text on landing page & docs with content writer.
• Complete SEO Setup

UI/UX

• Update Color schemes
• Update top-nav links for each product route (like sidebar)
• Use different color schemes for each product
• Write documentation for documentation and contribution guidelines
• Build the Glossary and reference to it.

Future Plans

• Create a contract/address management system as a single source of truth.
  • Automate the process so the devs. don’t have to remember/think about it!
• Use custom table component instead of MD table.
  • Add sort/filter functionality to tables.
• Custom component for eth addresses
  • Pop up with, copy, open in etherscan, debank, zapier …etc.
• Add multi language support.
• Make the documentation content open-source
  • Enable Edit this page on Github button.
  • Enable Translate this page button.
• Figure out a better way to collect questions & feedback.
• Add integration docs for each product
• Add /blog & /change-log

Documentation structure

Following is the base Documentation structure: for each of the products that will be visible on the sidebar. The idea is to follow roughly the same sections/steps when adding/structuring documentation. Afterwards collect feedback and iterate to make it a smoother learning/searching experience for the users.

Keep in mind that the structure is subject to change, it will be updated as more documentation is added…

- Product
    - Overview
    - Protocol Concepts 
    - Guides
    - Technical
    - Contribution
    - Other

• Overview: overview of the product,
• Protocol Concepts: Specifics about the protocol, terms, descriptions, contracts …etc.
• Guides: Tutorials, how-to’s
• Techical: Technical documentation for people who want to integrate/understand the products
• Contribution: Details on how to get involved/contribute as well as things like audits, bounties, …etc.
• Other: Other uncathegorized documentation.