Skip to content

Commit

Permalink
[Bn-1482]: Update Docs Branding From Topl to Apparatus (#30)
Browse files Browse the repository at this point in the history
* add direnv files

* Delete generated api docs

* Update references of the company Topl to Apparatus

* Fix some grammar

* Add pr template, code owners, lock files, update .gitignore

* remove link to outdated scaladocs

* Remove yarn.lock (let's just use NPM for GH actions)
  • Loading branch information
admiraladmirable authored May 30, 2024
1 parent f5de3d0 commit bb02cd2
Show file tree
Hide file tree
Showing 285 changed files with 259 additions and 9,293 deletions.
1 change: 1 addition & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
use flake
29 changes: 29 additions & 0 deletions .github/workflows/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Purpose

## Approach

## Testing

## Tickets
*


**Delete everything after and including this line after you are done reading and understand what to put for each section**

>### Purpose
>
>*State in plain words what the scope of the pull request and what problem it is trying to solve*
>
>### Approach
>
>*Enumerate the steps you took to create the code/changes contained in this pull request*
>
>### Testing
>
>*Specify all unit, integration, or end-to-end testing that is contained in this pull request*
>
>### Tickets
>
>*List tickets if any that are connected to this pull request in the following format:*
>
>_* closes #1234_
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ yarn-error.log*

# IDE
.idea

# Nix
.direnv
16 changes: 16 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Info on formatting this file at
# https://blog.github.com/2017-07-06-introducing-code-owners/

# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in the repo.
* @Topl/bifrost_reviewers

# Order is important. The last matching pattern has the most precedence.
# So if a pull request only touches javascript files, only these owners
# will be requested to review.
#*.js @octocat @github/js

# You can also use email addresses if you prefer.
#docs/* docs@example.com
6 changes: 3 additions & 3 deletions Changelog Posts/welcome-to-the-topl-knowledgebase.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Welcome to the Topl Knowledgebase"
slug: "welcome-to-the-topl-knowledgebase"
title: "Welcome to the Apparatus Knowledgebase"
slug: "welcome-to-the-apparatus-knowledgebase"
hidden: false
---
Welcome to the Topl knowledgebase!
Welcome to the Apparatus knowledgebase!
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Topl's Knowledge Base
The central repository for documentation and code examples to build on the Topl blockchain.
# Apparatus' Knowledge Base
The central repository for documentation and code examples to build on the Apparatus blockchain.

# Website

Expand Down
24 changes: 12 additions & 12 deletions docs/About/introducing-thunder.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
id: welcome
title: "About Topl"
slug: "about-topl"
title: "About Apparatus"
slug: "about-apparatus"
---

---
# Thunder, Built by Topl
# Thunder, Built by Apparatus

Topl's primary goal is empowering communities and builders, especially in emerging markets, and unlocking economic innovation through decentralized technology. Specifically, Topl has developed Thunder, a Layer 2 Bitcoin protocol fully compatible with both the current Bitcoin core as well as the most widely adopted standards already in the space.
Apparatus' primary goal is empowering communities and builders, especially in emerging markets, and unlocking economic innovation through decentralized technology. Specifically, Apparatus has developed Thunder, a Layer 2 Bitcoin protocol fully compatible with both the current Bitcoin core as well as the most widely adopted standards already in the space.

Our approach is straightforward: to enhance Bitcoin's capabilities and connect developers with key stakeholders to drive economic growth and positive impact. Topl Thunder is a platform and toolkit that channels Bitcoin's strengths towards tangible change, enabling a broader range of applications and solutions. This integration signifies more than a technical leap—it embodies our dedication to building a new digital, inclusive economy.
Our approach is straightforward: to enhance Bitcoin's capabilities and connect developers with key stakeholders to drive economic growth and positive impact. Apparatus Thunder is a platform and toolkit that channels Bitcoin's strengths towards tangible change, enabling a broader range of applications and solutions. This integration signifies more than a technical leap—it embodies our dedication to building a new digital, inclusive economy.

Financial inclusion is the gateway to a more inclusive and interconnected economy. By harnessing the power of Bitcoin, we're not only enhancing its utility but also boosting its circulation and demand as a premier digital asset.

Expand All @@ -19,23 +19,23 @@ Beyond its status as the first cryptocurrency, Bitcoin has emerged as a symbol o

Our decision to integrate with Bitcoin isn't just about tapping into its popularity; it's about aligning with a platform that shares our vision of financial empowerment. This integration aims to enhance the inherent benefits of Bitcoin, making it more functional, accessible, and impactful.

While current Layer 2 solutions have made Bitcoin more scalable and affordable, there's still room to do more. Topl Thunder amplifies Bitcoin's strengths and introduces features like decentralized applications, smart contracts, and diverse token structures. We don't merely see Bitcoin as a currency but as a solid base for DeFi and the tokenization of real-world assets (RWAs).
While current Layer 2 solutions have made Bitcoin more scalable and affordable, there's still room to do more. Apparatus Thunder amplifies Bitcoin's strengths and introduces features like decentralized applications, smart contracts, and diverse token structures. We don't merely see Bitcoin as a currency but as a solid base for DeFi and the tokenization of real-world assets (RWAs).

When you contrast the developer communities of Bitcoin and Ethereum, Ethereum seems ahead despite Bitcoin's longevity and vast market capitalization. This points to a distinct utility gap. Our ambition is to close that gap. Introducing Turing-complete smart contracts (among other functionalities), we're expanding the horizon of what's feasible on a Bitcoin-centric chain. Use cases and features that were once the domain of Ethereum can now find a home on Topl Thunder.
When you contrast the developer communities of Bitcoin and Ethereum, Ethereum seems ahead despite Bitcoin's longevity and vast market capitalization. This points to a distinct utility gap. Our ambition is to close that gap. Introducing Turing-complete smart contracts (among other functionalities), we're expanding the horizon of what's feasible on a Bitcoin-centric chain. Use cases and features that were once the domain of Ethereum can now find a home on Apparatus Thunder.

## Innovation and Compatibility

Topl Thunder acts as a versatile conduit to Bitcoin, equipping developers, entrepreneurs, and individuals to shape their digital landscapes anchored in Bitcoin's security.
Apparatus Thunder acts as a versatile conduit to Bitcoin, equipping developers, entrepreneurs, and individuals to shape their digital landscapes anchored in Bitcoin's security.

At the heart of our innovation is an eUTXO ledger design and a fully permissionless consensus mechanism, Taktikos. With this, Thunder enables compatibility with emerging client-side protocols in the Bitcoin ecosystem, like RGB, Ordinals, and Taproot/Taro Assets. Developers gain access to industry standards with the added benefits of reduced fees, faster throughput, and quicker finality. These are Thunder's key features:

**Interoperability:** Topl's modular design allows for seamless integration with other protocols, including Lightning, Taproot Assets, and Ordinals—amplifying access to capital, resources, and network benefits. We aim to knit together vibrant, interconnected communities.
**Interoperability:** Apparatus' modular design allows for seamless integration with other protocols, including Lightning, Taproot Assets, and Ordinals—amplifying access to capital, resources, and network benefits. We aim to knit together vibrant, interconnected communities.

**Off-chain Computation:** Our approach prioritizes inclusion. Light nodes ensure those from bandwidth-constrained regions can participate, even from low-resource devices. By shifting computation off-chain, we optimize computational efficiency and affordability, especially vital for participants from the Global South.

**UTxO Efficiency:** Topl boasts an efficient UTxO system that surpasses the security of many other protocols. With native asset integration and minimized smart contract reliance, we mitigate potential exploits. This robust architecture becomes especially pertinent for impact-driven use cases, such as traceability and carbon credit management.
**UTxO Efficiency:** Apparatus boasts an efficient UTxO system that surpasses the security of many other protocols. With native asset integration and minimized smart contract reliance, we mitigate potential exploits. This robust architecture becomes especially pertinent for impact-driven use cases, such as traceability and carbon credit management.

**Flexible Fungibility:** The Topl Asset Model (TAM) introduces gradient fungibility, redefining adaptability for both DeFi and RWAs. By allowing tokens to alter their group or series or to amalgamate with compatible assets, TAM sets the stage for innovation in digital asset management.
**Flexible Fungibility:** The Apparatus Asset Model (TAM) introduces gradient fungibility, redefining adaptability for both DeFi and RWAs. By allowing tokens to alter their group or series or to amalgamate with compatible assets, TAM sets the stage for innovation in digital asset management.

## Community and Collaboration

Expand All @@ -46,4 +46,4 @@ But technology, no matter how advanced, is only as good as the community behind
**We welcome everyone—developers, entrepreneurs, and visionaries—to join our mission. Let's mold the digital economy's future, driving it towards inclusivity and positive impact. Join us in our commitment to innovate, empower, and #buildgood.**

## Learn More
Beyond the documentaiton and tutorials contained in this developer portal, you can learn more about Topl's vision, tokenomics, and governance design by reading the [Thunder whitepaper](https://hackmd.io/@qiYljXhXTQeGAb1RWPghwQ/B1Y0YK0fp).
Beyond the documentaiton and tutorials contained in this developer portal, you can learn more about Apparatus' vision, tokenomics, and governance design by reading the [Thunder whitepaper](https://hackmd.io/@qiYljXhXTQeGAb1RWPghwQ/B1Y0YK0fp).
14 changes: 7 additions & 7 deletions docs/Bounty_Program/01-bounty-program-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ id: bounty-overview
title: "Bounty Overview"
slug: bounty-overview
---
# Topl's Community Bounty Program
# Apparatus' Community Bounty Program

We're excited to be launching our Community Bounty Program in December of 2023! We will post all Topl bounty opportunities to our [Dework space](https://app.dework.xyz/topl-97029/main-space-88431).
We're excited to be launching our Community Bounty Program in December of 2023! We will post all Apparatus bounty opportunities to our [Dework space](https://app.dework.xyz/topl-97029/main-space-88431).

We'd like to share with you the primary objectives of the Topl Bounty Program, and we hope that, regardless of your skills or expertise, we will be able to provide an opportunity for your contribution(s):
We'd like to share with you the primary objectives of the Apparatus Bounty Program, and we hope that, regardless of your skills or expertise, we will be able to provide an opportunity for your contribution(s):

🌏 To increase engagement in the Topl developer ecosystem and the broader Topl community by listing tasks (bounties) to be completed by external parties, reviewed by Topl team members (and, eventually, designated moderators), and rewarded.
🌏 To increase engagement in the Apparatus developer ecosystem and the broader Apparatus community by listing tasks (bounties) to be completed by external parties, reviewed by Apparatus team members (and, eventually, designated moderators), and rewarded.

🤝 To allow developers, creators, writers, builders, and thinkers to engage with and improve the Thunder protocol, tooling, and ecosystem in a fair and safe environment.

🛡 To utilize the skills and talents of the community to find bugs, thereby improving the security of the Topl network.
🛡 To utilize the skills and talents of the community to find bugs, thereby improving the security of the Apparatus network.



## Steps to get involved in Topl's Community Bounty Program
## Steps to get involved in Apparatus' Community Bounty Program

🛠 Check us out on [Dework](https://app.dework.xyz/topl-97029/main-space-88431) to see if any of the currently listed tasks are a good fit for your expertise and skill sets. If you don't see a task that looks like a good fit, hang tight! Different core teams (engineering, product, growth, tokenomics, etc) will be posting bounties as often as we can. If you have some ideas of how you can contribute, email us at community@topl.me, to see if we can co-create a bounty for your proposed task.

🎨 Create your Dework profile. We encourage you to put as much thought into this as possible to ensure that your profile adequately represents your skills and areas of interest.

📜 Read through our [Rules of Engagement](02-rules-of-engagement.md).

⚖️ Read through our [Bounty Program Participant Agreement](https://legal.topl.co/Bounty_Program_Agreement) (all participants are subject to this agreement).
⚖️ Read through our [Bounty Program Participant Agreement](https://legal.apparatus.live/Bounty_Program_Agreement) (all participants are subject to this agreement).

📣 Reach out to us in [Discord](https://discord.gg/qS6QMGZ4fa) or at community@topl.me with any questions.

Loading

0 comments on commit bb02cd2

Please sign in to comment.