-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Malachite Docs | ||
|
||
> [!TIP] | ||
> Malachite documentation is still in the early stages of development. | ||
> We welcome contributions! | ||
> We also invite feedback and input on what would be the most important aspects | ||
> of documentations to cover, for [example](https://diataxis.fr/), tutorials, | ||
> how-to guides, explanations, references? | ||
## Building with Malachite | ||
|
||
If you are a developer looking to _build_ with Malachite, | ||
then we suggest as a starting point: | ||
|
||
1. the main [ARCHITECTURE.MD](../ARCHITECTURE.md) | ||
2. the [tutorials](tutorials), which currently comprises an example on how to build an application using [Tokio](https://tokio.rs) channels. | ||
|
||
## Contributing to Malachite | ||
|
||
If you are a developer looking to _contribute_ to Malachite or learn more, | ||
then in addition to the resources above, you may want to consult: | ||
|
||
1. The log of Architecture Decision Records (ADRs) in [architecture](./architecture); these capture various decisions at previous points in time regarding architectural concerns. | ||
2. The log of [development proposals](./development-proposals), which describes potential improvements or features for Malachite, depending on specific use-cases such as the Starknet decentralized sequencer. | ||
3. Some notes on [testing](./testing) Malachite locally within Docker. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Malachite Testing Notes | ||
|
||
This directory collects notes on testing and experimenting with Malachite. | ||
For more comprehensive testing, please see [QA](../../qa). | ||
|
||
- [local](./local.md) - testing Malachite locally within Docker |