Skip to content

Commit

Permalink
make acks and forks more obvious at top of docs
Browse files Browse the repository at this point in the history
due to the continued addition of other docs these were getting deeper
and deeper buried into the documentation, without intention,
but very unfortunate none the less

this commit rectifies that
  • Loading branch information
GlenDC committed Jan 19, 2025
1 parent ff02102 commit 891224b
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 1 deletion.
1 change: 0 additions & 1 deletion FORK.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ as a distant relative.
## Relative Forks

- <https://github.com/tokio-rs/axum/tree/e0b55d750390d810028caad0387058751611c1b4>
- FromRef (proc macro), we use it in a different form using `std::convert::AsRef` (to avoid clones);
- IntoResponse Code
- (Optional)FromRequest/ (Optional)FromRequestParts code
- Error/BoxError
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@
> Rama is all about empowerement and modularity. It is there to aid you in building your proxies, servers and clients,
> without getting in your way and without stopping you in your mission where rama might fall short. A web stack
> build with Rama can always be customised to your needs, even if that particular part or layer is custom to your purpose only.
>
> It goes without saying That Rama is built upon the shoulders of giants.
> Please refer to [the acknowledgements](#Acknowledgements) for more information about this.
>
> Where required we had to fork other crates due to an incompatibility in needs or scope,
> while this is unfortuante as it leads to more work for us, we gladly do so in case
> it fits in our mission of empowerement of rama users, including ourselves.
> You can find more information about these forks at <https://github.com/plabayo/rama/blob/main/FORK.md>.
> As much as possible we preserve the code layout of forked cod modules, as to be able
> to keep in sync with upstream and push patches upstream where applicable.
Rama is async-first using [Tokio](https://tokio.rs/) as its _only_ Async Runtime.
Please refer to [the examples found in the `/examples` dir](https://github.com/plabayo/rama/tree/main/examples)
Expand Down
11 changes: 11 additions & 0 deletions docs/book/src/preface.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@
> Rama is all about empowerement and modularity. It is there to aid you in building your proxies, servers and clients,
> without getting in your way and without stopping you in your mission where rama might fall short. A web stack
> build with Rama can always be customised to your needs, even if that particular part or layer is custom to your purpose only.
>
> It goes without saying That Rama is built upon the shoulders of giants.
> Please refer to the acknowledgements at <https://github.com/plabayo/rama?tab=readme-ov-file>
> for more information about this.
>
> Where required we had to fork other crates due to an incompatibility in needs or scope,
> while this is unfortuante as it leads to more work for us, we gladly do so in case
> it fits in our mission of empowerement of rama users, including ourselves.
> You can find more information about these forks at <https://github.com/plabayo/rama/blob/main/FORK.md>.
> As much as possible we preserve the code layout of forked cod modules, as to be able
> to keep in sync with upstream and push patches upstream where applicable.
Rama is async-first using [Tokio](https://tokio.rs/) as its _only_ Async Runtime.
Please refer to [the examples found in the `/examples` dir](https://github.com/plabayo/rama/tree/main/examples)
Expand Down
11 changes: 11 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@
//! > Rama is all about empowerement and modularity. It is there to aid you in building your proxies, servers and clients,
//! > without getting in your way and without stopping you in your mission where rama might fall short. A web stack
//! > build with Rama can always be customised to your needs, even if that particular part or layer is custom to your purpose only.
//! >
//! > It goes without saying That Rama is built upon the shoulders of giants.
//! > Please refer to the acknowledgements at <https://github.com/plabayo/rama?tab=readme-ov-file>
//! > for more information about this.
//! >
//! > Where required we had to fork other crates due to an incompatibility in needs or scope,
//! > while this is unfortuante as it leads to more work for us, we gladly do so in case
//! > it fits in our mission of empowerement of rama users, including ourselves.
//! > You can find more information about these forks at <https://github.com/plabayo/rama/blob/main/FORK.md>.
//! > As much as possible we preserve the code layout of forked cod modules, as to be able
//! > to keep in sync with upstream and push patches upstream where applicable.
//!
//! Rama is async-first using [Tokio](https://tokio.rs/) as its _only_ Async Runtime.
//! Please refer to [the examples found in the `/examples` dir](https://github.com/plabayo/rama/tree/main/examples)
Expand Down

0 comments on commit 891224b

Please sign in to comment.