Station Alert:
- Available now at docs.astroport.fi, astronauts throughout the galaxy can learn to build on or contribute to the Astroport protocol today
- Open-source and feature-rich, the knowledge base includes line-by-line walkthroughs or “Code Hikes” through every character in Astroport’s codebase, “Edit this page” functionality, Github and Docusaurus integrations and more
More than a wiki, Astroport contributors have spent the past six months integrating leading technologies into a fluid and extensible knowledgebase available at docs.astroport.fi. Features include:
- Interactive, line-by-line walkthroughs or “Code Hikes” of every character in Astroport’s codebase
- An intuitive interface powered by Docusaurus, which is used by core DeFi protocols throughout the galaxy including Uniswap, Sushiswap, Yearn, Osmosis, and Terra
- An “Edit this page” feature on every docs entry
- Github-powered commits that gives devs the ability to track changes and quickly submit changes via pull requests
The following sections explore Astroport’s docs and detail how you can contribute to them today.
Docs Architecture
In order to reach all travelers, Astroport’s new docs have been structured with three main zones in mind:
- Learn: For explorers discovering Astroport and the Astroport Web App
- Govern: For elders ascending to the Astral Assembly
- Develop: For engineers leveraging Astroport’s smart contracts
This multi-zone architecture has influenced the design of the landing station (docs.astroport.fi) where travelers are first greeted by three portals, which can teleport them directly to their favorite subzones.
Learn: Discover the Astroport Protocol and Web App
In the “Learn” zone, travelers will be able to enhance their knowledge of the inner workings of Astroport, such as the protocol’s unique architecture for dual liquidity mining, its various pool types, and more. This section will also be in rapid development as Astroport sets its course to new destinations in the Cosmos. Primitives such as multi-chain fee sharing and multi-chain governance, both powered through IBC, are yet to be clarified until the Astral Assembly, Astroport’s governing body of users, finalizes such details.
After learning about the protocol, you can also put your knowledge to work. With the release of the new UI at Astroport.fi, step-by-step tutorials (found under “Workstation”) have been completely redesigned to guide you through the new App experience. New tutorials will also include limit orders and Injective-related material as the functionality becomes available in the Astroport.fi frontend.
Govern: Ascend to the Astral Assembly
On-chain protocol governance, like the model used by the Astral Assembly, introduces a novel method of consensus building where anyone throughout the galaxy can participate in the direct management of Astroport’s commons without the interference of centralized parties or intermediaries. With the power of smart contracts, protocol-level governance also has the advantage of capital and judicial efficiency, where key decisions (such as parameter changes to the Astroport protocol or the distribution of community funds) can be executed autonomously.
Despite its advantages, users sometimes need technical knowledge or assistance from enhanced block explorers like the Astroport Web App to participate in the Astral Assembly (staking, voting, and submitting proposals). With the release of its new UI, Astroport.fi will continue to maintain a first-class experience for travelers looking to quickly take care of their governance needs. In addition to this, docs.astroport.fi will also maintain a new repository of tutorials for explorers looking to expand their on-chain protocol skills.
For example, Assembly members can learn how to structure a proposal and fine-tune allocation points in the Generator contract, which updates the Generator contract’s configuration parameters, and redistributing ASTRO token emissions for all Astroport pools. This single proposal (and corresponding tutorial) directly places the future of Astroport’s emissions and longevity in the hands of xASTRO stakers. For developers looking to integrate with Astroport, core proposals that drive liquidity to the protocol, such as integrating proxy contracts and dual rewards, are also covered.
To make the journey as smooth as possible, the documentation repository features Code Hikes, a package used to build first-class code walkthroughs for technical content. Users will enjoy a guided experience, with step-by-step tutorials and interactive code blocks that direct you along the way.
Develop: Start Building on Astroport
The “Develop” section has also received a huge upgrade from the previous docs. The two main sections for developers include “Smart Contracts” and “Tutorials”.
Under “Smart Contracts”, developers can find new and improved documentation for every Astroport contract. Hovering over parameters may focus on specific areas of the docs, providing for a superior code reading experience.
Under “Tutorials”, developers can put their knowledge of Astroport’s codebase to work. This section references “Smart Contracts” often but focuses on more specific and actionable items, such as how to swap, provide liquidity, etc., each of which could require interacting with multiple contracts at a time. This section also leverages Code Hikes to provide a seamless step-by-step experience for integrations.
Open-Sourcing the Astroport Docs
The inspiration for open-sourcing Astroport docs is to make Astroport’s core information station open to anyone. From now on, the docs will live as an open-source project at https://github.com/astroport.fi/docs. This means anyone can contribute to the docs directly by submitting a pull request to the GitHub repo.
To encourage contributions, Astroport has activated an “Edit this Page” feature at the bottom of docs pages. This is a user-friendly method for anyone with a GitHub account to quickly submit a pull request for markdown-related edits through the GitHub GUI.
The Road Ahead
With the upcoming Injective mainnet launch, Astroport is set to embark on a multi-chain voyage through the Cosmos. During this period, you can expect updates to the docs by Astroport contributors (trackable through GitHub commits). After the Injective mainnet launch, a more detailed guide for contributions (used to evaluate pull requests) and additional information for interested contributors will be released.
Aside from decentralizing the docs infrastructure, Astroport contributors are currently experimenting with new features in the research lab. More information is set to be released as details become available. Discover Astroport now at docs.astroport.fi.
✦
Follow Astroport on Twitter and subscribe to the Astroport email newsletter to get the latest alerts from the mothership.
DISCLAIMER
Remember, Terra 2.0, Injective and Astroport are experimental technologies. This article does not constitute investment advice and is subject to and limited by the Astroport disclaimers, which you should review before interacting with the protocol.
