-
-
Notifications
You must be signed in to change notification settings - Fork 9
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
CI
committed
May 25, 2022
0 parents
commit 3935b22
Showing
134 changed files
with
13,475 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
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,3 @@ | ||
| <!doctype html> | ||
| <title>404 Not Found</title> | ||
| <h1>404 Not Found</h1> |
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 @@ | ||
| ruma.io |
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 @@ | ||
| article h1,article h2,article h3{font-weight:500}article h1{font-size:1.75em}article h2{font-size:1.5em}article h3{font-size:1.25em} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 @@ | ||
| .content{max-width:780px;margin:0 auto;padding:0 15px}.post-header{margin-bottom:1.5em}.post-header small{font-size:90%}.post-header time,.post-header .author{font-weight:500}.post-title{margin-bottom:.2em} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 @@ | ||
| .pagination{margin-top:4rem;text-align:center}.pagination .prev,.pagination .next{display:inline-block;margin:1rem} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,65 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
|
|
||
| <meta charset="utf-8"> | ||
| <meta http-equiv="x-ua-compatible" content="ie=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> | ||
| <link rel="alternate" type="application/atom+xml" href="/news/feed.xml" title="Ruma" /> | ||
|
|
||
| <meta http-equiv="Content-Security-Policy" content=" | ||
| default-src 'self'; | ||
| script-src 'none'; | ||
| style-src 'self' 'unsafe-inline'; | ||
| frame-src 'none'"> | ||
|
|
||
| <title>How to Contribute | Ruma</title> | ||
|
|
||
| <link rel="stylesheet" href="/normalize.css"> | ||
| <link rel="stylesheet" href="/site.css"> | ||
|
|
||
| <nav class="site-nav"> | ||
| <ul> | ||
|
|
||
| <li><a href="/">Home</a></li> | ||
|
|
||
| <li><a href="/news/">News</a></li> | ||
|
|
||
| <li><a href="/projects/">Projects using Ruma</a></li> | ||
|
|
||
| <li><a href="https://liberapay.com/ruma/">Donate on Liberapay</a></li> | ||
|
|
||
| <li><a href="/docs/">Documentation</a></li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
| <div class="page"> | ||
|
|
||
|
|
||
| <main class="content"> | ||
| <h1 class="page-title">How to Contribute</h1> | ||
| <p>If you're interested in contributing to the Ruma project, this page offers some pointers on how to get started.</p> | ||
| <p>The most significant thing you can do to help the project is to try to build something using it. | ||
| Since homeserver development has ended, this means building something like a bot or GUI client using the <a href="/docs/crates/ruma-client/">ruma-client</a> library. | ||
| As you work, you can help by opening issues and/or pull requests on the relevant Ruma libraries as issues come up. | ||
| This will help ensure that Ruma is suitable for real-world use cases.</p> | ||
| <p>If you are more interested in contributing code to the project without building your own software, there are a couple places you might spend your time.</p> | ||
| <p>If you have experience with cryptography and/or C programming, you can work on Rust support for <a href="https://gitlab.matrix.org/matrix-org/olm">Olm</a>, the library that supports end-to-end encryption in Matrix. | ||
| It's possible that the maintainers of Olm would be interested in Rust support within Olm itself. | ||
| If not, you could work on exposing Olm's C API as safe Rust. | ||
| One such project already exists: <a href="https://crates.io/crates/olm-rs">olm-rs</a>. | ||
| olm-rs might need some additional help. | ||
| If you're very confident in your skills with implementing cryptographic algorithms, you could attempt to port Olm to Rust directly, though it's not clear if this would be possible without any C code at all.</p> | ||
| <p>The second major area where code contributions would help would be to work on equivalents of <a href="/docs/crates/ruma-client-api/">ruma-client-api</a> for the other Matrix APIs (e.g. <a href="https://matrix.org/docs/spec/server_server/latest">federation</a>.) | ||
| ruma-client-api is the library that defines the Rust interface for all the HTTP endpoints in the Matrix client-server API. | ||
| An equivalent library will eventually be needed for the other Matrix APIs.</p> | ||
| <p>GitHub issues across all of Ruma's repositories are tagged with "effort" levels, so looking for issues tagged with "effort/easy" is also a good way to find smaller, entry-level issues to take on.</p> | ||
| <p>Lastly, if you want to offer financial support to the developers of Ruma, you can <a href="https://liberapay.com/ruma/">donate to Ruma on Liberapay</a>.</p> | ||
| <p>Thank you for your interest in contributing to Ruma!</p> | ||
|
|
||
| </main> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </html> |
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,82 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
|
|
||
| <meta charset="utf-8"> | ||
| <meta http-equiv="x-ua-compatible" content="ie=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> | ||
| <link rel="alternate" type="application/atom+xml" href="/news/feed.xml" title="Ruma" /> | ||
|
|
||
| <meta http-equiv="Content-Security-Policy" content=" | ||
| default-src 'self'; | ||
| script-src 'none'; | ||
| style-src 'self' 'unsafe-inline'; | ||
| frame-src 'none'"> | ||
|
|
||
| <title>Ruma's crates | Ruma</title> | ||
|
|
||
| <link rel="stylesheet" href="/normalize.css"> | ||
| <link rel="stylesheet" href="/site.css"> | ||
|
|
||
| <nav class="site-nav"> | ||
| <ul> | ||
|
|
||
| <li><a href="/">Home</a></li> | ||
|
|
||
| <li><a href="/news/">News</a></li> | ||
|
|
||
| <li><a href="/projects/">Projects using Ruma</a></li> | ||
|
|
||
| <li><a href="https://liberapay.com/ruma/">Donate on Liberapay</a></li> | ||
|
|
||
| <li><a href="/docs/">Documentation</a></li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
| <div class="page"> | ||
|
|
||
|
|
||
| <h1 class="section-title">Ruma's crates</h1> | ||
|
|
||
| <div class="section-nav-content-wrap"> | ||
| <aside class="section-nav"> | ||
| <ul> | ||
| <li><a href="https://www.ruma.io/docs/crates/">Overview</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-client-api/">ruma-client-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-api/">ruma-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-client/">ruma-client</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-appservice-api/">ruma-appservice-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-events/">ruma-events</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-signatures/">ruma-signatures</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-identifiers/">ruma-identifiers</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-federation-api/">ruma-federation-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-push-gateway-api/">ruma-push-gateway-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-common/">ruma-common</a></li> | ||
|
|
||
| </ul> | ||
| </aside> | ||
|
|
||
|
|
||
| <main class="content"> | ||
| <p>The Ruma project consists of many libraries, some of them small and some pretty | ||
| large. All of them are released as Rust crates on <a href="https://crates.io">crates.io</a>.</p> | ||
| <p>Select an application or library from the menu to learn more about it and its | ||
| role in the Ruma ecosystem.</p> | ||
|
|
||
| </main> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </html> |
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,95 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
|
|
||
| <meta charset="utf-8"> | ||
| <meta http-equiv="x-ua-compatible" content="ie=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> | ||
| <link rel="alternate" type="application/atom+xml" href="/news/feed.xml" title="Ruma" /> | ||
|
|
||
| <meta http-equiv="Content-Security-Policy" content=" | ||
| default-src 'self'; | ||
| script-src 'none'; | ||
| style-src 'self' 'unsafe-inline'; | ||
| frame-src 'none'"> | ||
|
|
||
| <title>ruma-api | Ruma</title> | ||
|
|
||
| <link rel="stylesheet" href="/normalize.css"> | ||
| <link rel="stylesheet" href="/site.css"> | ||
|
|
||
| <nav class="site-nav"> | ||
| <ul> | ||
|
|
||
| <li><a href="/">Home</a></li> | ||
|
|
||
| <li><a href="/news/">News</a></li> | ||
|
|
||
| <li><a href="/projects/">Projects using Ruma</a></li> | ||
|
|
||
| <li><a href="https://liberapay.com/ruma/">Donate on Liberapay</a></li> | ||
|
|
||
| <li><a href="/docs/">Documentation</a></li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
| <div class="page"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h1 class="section-title">Ruma's crates</h1> | ||
|
|
||
| <div class="section-nav-content-wrap"> | ||
| <aside class="section-nav"> | ||
| <ul> | ||
| <li><a href="https://www.ruma.io/docs/crates/">Overview</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-client-api/">ruma-client-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-api/">ruma-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-client/">ruma-client</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-appservice-api/">ruma-appservice-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-events/">ruma-events</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-signatures/">ruma-signatures</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-identifiers/">ruma-identifiers</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-federation-api/">ruma-federation-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-push-gateway-api/">ruma-push-gateway-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-common/">ruma-common</a></li> | ||
|
|
||
| </ul> | ||
| </aside> | ||
|
|
||
|
|
||
| <main class="content"> | ||
| <h2 class="page-title">ruma-api</h2> | ||
| <p><code>ruma-api</code> contains core types used to define the requests and responses for each endpoint in the various Matrix API specifications.</p> | ||
|
|
||
| <p>Links:</p> | ||
| <ul> | ||
| <li><a href="https://crates.io/crates/ruma-api">crates.io page</a></li> | ||
| <li><a href="https://docs.rs/ruma-api">Documentation</a></li> | ||
| <li><a href="https://github.com/ruma/ruma/tree/main/crates/ruma-api">Code</a></li> | ||
| <li> | ||
| <a href="https://github.com/ruma/ruma/issues?q=is%3Aissue+is%3Aopen+label%3Acrate%2Fruma-api"> | ||
| Issues | ||
| </a> | ||
| </li> | ||
| </dl> | ||
| </main> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </html> |
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,96 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
|
|
||
| <meta charset="utf-8"> | ||
| <meta http-equiv="x-ua-compatible" content="ie=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> | ||
| <link rel="alternate" type="application/atom+xml" href="/news/feed.xml" title="Ruma" /> | ||
|
|
||
| <meta http-equiv="Content-Security-Policy" content=" | ||
| default-src 'self'; | ||
| script-src 'none'; | ||
| style-src 'self' 'unsafe-inline'; | ||
| frame-src 'none'"> | ||
|
|
||
| <title>ruma-appservice-api | Ruma</title> | ||
|
|
||
| <link rel="stylesheet" href="/normalize.css"> | ||
| <link rel="stylesheet" href="/site.css"> | ||
|
|
||
| <nav class="site-nav"> | ||
| <ul> | ||
|
|
||
| <li><a href="/">Home</a></li> | ||
|
|
||
| <li><a href="/news/">News</a></li> | ||
|
|
||
| <li><a href="/projects/">Projects using Ruma</a></li> | ||
|
|
||
| <li><a href="https://liberapay.com/ruma/">Donate on Liberapay</a></li> | ||
|
|
||
| <li><a href="/docs/">Documentation</a></li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
| <div class="page"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h1 class="section-title">Ruma's crates</h1> | ||
|
|
||
| <div class="section-nav-content-wrap"> | ||
| <aside class="section-nav"> | ||
| <ul> | ||
| <li><a href="https://www.ruma.io/docs/crates/">Overview</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-client-api/">ruma-client-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-api/">ruma-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-client/">ruma-client</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-appservice-api/">ruma-appservice-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-events/">ruma-events</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-signatures/">ruma-signatures</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-identifiers/">ruma-identifiers</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-federation-api/">ruma-federation-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-push-gateway-api/">ruma-push-gateway-api</a></li> | ||
|
|
||
| <li><a href="https://www.ruma.io/docs/crates/ruma-common/">ruma-common</a></li> | ||
|
|
||
| </ul> | ||
| </aside> | ||
|
|
||
|
|
||
| <main class="content"> | ||
| <h2 class="page-title">ruma-appservice-api</h2> | ||
| <p><code>ruma-appservice-api</code> contains serializable types for the requests and responses for each endpoint in the Matrix appservice API. | ||
| It implements the generic interface for Matrix APIs defined in <a href="/docs/crates/ruma-api/">ruma-api</a>.</p> | ||
|
|
||
| <p>Links:</p> | ||
| <ul> | ||
| <li><a href="https://crates.io/crates/ruma-appservice-api">crates.io page</a></li> | ||
| <li><a href="https://docs.rs/ruma-appservice-api">Documentation</a></li> | ||
| <li><a href="https://github.com/ruma/ruma/tree/main/crates/ruma-appservice-api">Code</a></li> | ||
| <li> | ||
| <a href="https://github.com/ruma/ruma/issues?q=is%3Aissue+is%3Aopen+label%3Acrate%2Fruma-appservice-api"> | ||
| Issues | ||
| </a> | ||
| </li> | ||
| </dl> | ||
| </main> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </html> |
Oops, something went wrong.