Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/doc improvements 3 #71

Merged
merged 16 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 50 additions & 13 deletions framework/docs/src/0_abstract_documentation.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,59 @@
<!-- # The Abstract Development Platform -->
<!-- This page is a high-level overview of the Abstract Platform, not the SDK or any of our actual products. Hence we should stick to a vocabulary that is familiar to the reader. -->
![Abstract Platform](resources/abstract_platform/abstract_overview.webp)
<!--
<div align="center">

### Welcome to Abstract, the interchain CosmWasm development platform. </br>We are building tools and infrastructure for composable smart-contract applications.

</div> -->

# Abstract Documentation

Hi and welcome to Abstract, the interchain CosmWasm development platform! Abstract's CosmWasm framework is your gateway
to taking amazing ideas from concept to reality. Whether you're a coding genius or just getting started, Abstract has got your back! By building composable modules you'll be crafting scalable masterpieces in no time.
Hi and welcome to Abstract, the interchain CosmWasm development platform! Abstract's CosmWasm framework is your gateway
to taking amazing ideas from concept to reality. Whether you're a coding genius or just getting started, Abstract has
got your back! By building composable modules you'll be crafting scalable masterpieces in no time.

## Abstract in a nutshell

Abstract is a CosmWasm development platform designed to simplify the creation of secure and powerful blockchain
applications. It offers a modular architecture and a suite of tools that streamline the development process, making it
easier for developers to innovate in the blockchain domain.

### Abstract Products

- **CW-Orchestrator**: A scripting tool crafted to simplify interactions with CosmWasm smart contracts. It offers macros that
generate type-safe interfaces, promoting code readability, and reducing testing and deployment overhead.

- **Abstract JS**: A comprehensive JavaScript library designed for easy integration with on-chain Abstract functions. It
caters to both developers aiming to embed blockchain functionalities in their apps and enthusiasts exploring the
Abstract framework.

- **Abstract App Template**: A foundational template for developing apps within the Abstract framework. It provides the
essentials for building and integrating new Abstract Apps, facilitating both frontend and smart contract templates.

- **Abstract Testing**: A testing utility within the Abstract framework. It focuses on providing mock data creation, querying,
and robust unit testing functionalities to ensure the correctness of the framework's components.


## Getting Started
These products collectively support developers in building, testing, and deploying CosmWasm-based applications with
enhanced efficiency and security.

You can read the documentation in the order it is presented, or you can jump to the section that interests you the most! We
also have a section with code tutorials that will help you get started with the Abstract SDK if you are more of a hands-on.
## How to navigate the docs

- [Abstract Overview](./1_abstract_platform_overview.md)
- [Tutorials](./10_tutorials.md)
You can read the documentation in the order it is presented, or you can jump to the section that interests you the most!
We also have a section with code tutorials that will help you get started with the Abstract SDK if you are more of a
hands-on.

## Explore the Abstract SDK
Here are some useful links to get you started:

- [Abstract Overview](./1_abstract_platform_overview.md)
- [Core Features](./1_abstract_platform_overview.md)
- [Platform Essentials](./1_abstract_platform_overview.md)
- [Build with Abstract](./4_get_started/)
- [Abstract Overview, Core Features and Platform Essentials](./1_abstract_platform_overview.md)
- [Abstract SDK](./3_framework/1_abstract_sdk.md)
- [Build with Abstract](./4_get_started/1_index.md)
- [Abstract Platform](./5_platform/index.md)
- [Abstract Products](./1_products/index.md)
- [Use Cases](./7_use_cases/index.md)
- [Monetization on Abstract](./5_platform/6_monetization.md)
- [Glossary](./9_glossary.md)

## Use Cases
Expand Down Expand Up @@ -49,7 +86,7 @@ If you feel lost or have any doubts along the way, please reach out to us! We ar

## Want to make Abstract better?

We are always looking for ways to improve Abstract and welcome everybody to contribute to the project. Look at the
We are always looking for ways to improve Abstract and welcome everybody to contribute to the project. Look at the
[Contributing & Community](./contributing.md) section if you want to get involved.

## Links
Expand Down
43 changes: 8 additions & 35 deletions framework/docs/src/10_integrations.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,10 @@
# Abstract Integrations

!todo

- Here's a list of some of the projects we're currently integrated with:

- Dexes: WyndDex, Osmosis, Astroport, White Whale, and TerraSwap
- Oracles: Ojo Network (planned)
- Wallets: Keplr, Cosmostation and Terra Station
- Automation: CronCat and Lit Protocol (planned)



match value {
crate::exchanges::junoswap::JUNOSWAP => {
Ok(Box::<crate::exchanges::junoswap::JunoSwap>::default())
}
abstract_wyndex_adapter::WYNDEX => {
Ok(Box::<abstract_wyndex_adapter::dex::WynDex>::default())
}
abstract_osmosis_adapter::OSMOSIS => {
Ok(Box::<abstract_osmosis_adapter::dex::Osmosis>::default())
}
crate::exchanges::terraswap::TERRASWAP => {
Ok(Box::<crate::exchanges::terraswap::Terraswap>::default())
}
abstract_astroport_adapter::ASTROPORT => {
Ok(Box::<abstract_astroport_adapter::dex::Astroport>::default())
}
crate::exchanges::kujira::KUJIRA => Ok(Box::<crate::exchanges::kujira::Kujira>::default()),
_ => Err(DexError::UnknownDex(value.to_owned())),
}


croncat

dca
There are many integrations available for the Abstract SDK, and the list keeps expanding as the community and ourselves
develops more modules. Here's a list of some of the projects we are currently integrated with:

- **Dexes**: WyndDex, Osmosis, Astroport, White Whale, and TerraSwap
- **Oracles**: Ojo Network (planned), NOIS network
- **Wallets**: Keplr, Cosmostation and Terra Station
- **Automation**: CronCat and Lit Protocol (planned)
- **Data**: Numia
8 changes: 4 additions & 4 deletions framework/docs/src/1_abstract_platform_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ easier and faster to build for you.
The following is the list of products that make up the Abstract platform:

- [Abstract SDK](3_framework/1_abstract_sdk.md): On-chain smart-contract infrastructure.
- [CW-Orchestrator](1_products/cw_orchestrator.md): Multi-environment CosmWasm smart-contract deployment and scripting
- [CW-Orchestrator](1_products/1_cw_orchestrator.md): Multi-environment CosmWasm smart-contract deployment and scripting
library.
- [Abstract-Testing](1_products/abstract_testing.md): Unit testing utilities for CosmWasm contracts.
- [Abstract.js](1_products/abstract_js.md): Front-end libraries.
- [Abstract App Template](1_products/abstract_app_template.md): Starting point for building an Abstract App.
- [Abstract-Testing](1_products/3_abstract_testing.md): Unit testing utilities for CosmWasm contracts.
- [Abstract.js](1_products/4_abstract_js.md): Front-end libraries.
- [Abstract App Template](1_products/2_abstract_app_template.md): Starting point for building an Abstract App.
- <a href="https://api.abstract.money/" target="_blank">Graphql API Explorer</a>

Feel free to explore them individually at your own pace or follow the documentation as it is presented to you. If you
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The Abstract App Module Template is a starting point for developing apps that en
Accounts into standalone products. An app is instantiated for each Account individually and it's migratable. Apps are
allowed to perform actions on the Account and may also integrate with other apps and Adapters installed on the Account.
For a deeper understanding of Abstract Accounts, please refer to
the [abstract accounts](../3_framework/4_architecture.md)
the [abstract accounts](../3_framework/3_architecture.md)
documentation. If you're interested in learning about apps, consult
the [app module documentation](../3_framework/7_module_types.md).
the [app module documentation](../3_framework/6_module_types.md).

The primary focus of the Abstract App Template as of now is to provide a template for building a new Abstract App, as
well
Expand Down
20 changes: 20 additions & 0 deletions framework/docs/src/1_products/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Abstract Products

We are committed to delivering robust and versatile solutions tailored for the evolving demands of modern decentralized
applications.

The following are the products that make up the Abstract Platform:

1. **[CW-Orchestrator](1_cw_orchestrator.md)**: offers streamlined interactions with CosmWasm contracts through type-safe
interfaces.
2. **[Abstract App Template](2_abstract_app_template.md)**: provides a foundational structure for developing
transformative Abstract Account-based apps.
3. **[Abstract Testing](3_abstract_testing.md)**: emphasizes advanced mocking and querying, essential for robust unit
testing within the Abstract framework.
4. **[Abstract JS](4_abstract_js.md)**: bridges JavaScript applications and the on-chain Abstract framework, ensuring
effortless blockchain interactions.

### 🚀 Evolving Suite

At Abstract, we're continuously innovating. Stay tuned as we constantly expand our range, introducing
new products and refinements to empower your blockchain journey.
Loading