Improve docs

Author: cabol

CHANGELOG.md

@@ -1,8 +1,7 @@
 # Changelog
 
-## [v3.0.0-rc.1](https://github.com/elixir-nebulex/nebulex_distributed/tree/v3.0.0-rc.1) (2025-05-11)
-
-[Full Changelog](https://github.com/elixir-nebulex/nebulex_distributed/compare/2c6188ebb9a482cd75a97b6abdb2feddcfb189c9...v3.0.0-rc.1)
+## [v3.0.0-rc.1](https://github.com/elixir-nebulex/nebulex_distributed/tree/v3.0.0-rc.1) (2025-06-07)
+> [Full Changelog](https://github.com/elixir-nebulex/nebulex_distributed/compare/2c6188ebb9a482cd75a97b6abdb2feddcfb189c9...v3.0.0-rc.1)
 
 ### Enhancements
 
@@ -19,6 +18,9 @@
 
 ### Backwards incompatible changes
 
+- [Nebulex.Distributed] `Nebulex.Distributed` requires Erlang/OTP 25 or later.
+- [Nebulex.Distributed.RPC] The usage of async tasks for the RPC calls has been
+  removed (for OTP < 23). The new `Nebulex.Distributed.RPC` module uses `:erpc`.
 - [Nebulex.Adapters.Multilevel] Option `:model` is no longer supported. Please
   use the option `:inclusion_policy` instead.
 - [Nebulex.Adapters.Multilevel] The previous extended function `model/0,1` has
@@ -28,8 +30,6 @@
   adapter uses `ExHashRing` for key distribution under-the-hood.
 - [Nebulex.Adapters.Partitioned] The option `:join_timeout` is no longer
   supported.
-- [Nebulex.Distributed.RPC] The usage of async tasks for the RPC calls has been
-  removed (for OTP < 23). The new `Nebulex.Distributed.RPC` module uses `:erpc`.
 
 ### Closed issues
 
@@ -39,6 +39,3 @@
   [#2](https://github.com/elixir-nebulex/nebulex_distributed/issues/2)
 - Upgrade to Nebulex v3.0.0
   [#1](https://github.com/elixir-nebulex/nebulex_distributed/issues/1)
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

README.md

@@ -15,8 +15,8 @@ cache topologies, but this feature will depend on the adapters. Here is where
 **"Nebulex Distributed"** comes in. It provides the following adapters to set up
 distributed topologies:
 
-  * `Nebulex.Adapters.Multilevel` - Multi-level distributed cache topology.
   * `Nebulex.Adapters.Partitioned` - Partitioned cache topology.
+  * `Nebulex.Adapters.Multilevel` - Multi-level distributed cache topology.
   * `Nebulex.Adapters.Replicated` - Replicated cache topology (**WIP!**).
 
 These adapters work more as wrappers for an existing local adapter and provide
@@ -36,6 +36,10 @@ def deps do
 end
 ```
 
+See the [online documentation][online_docs] for more information.
+
+[online_docs]: http://hexdocs.pm/nebulex_distributed
+
 ## Partitioned cache topology example
 
 You can define a partitioned cache as follows:
@@ -136,10 +140,6 @@ def start(_type, _args) do
   ]
 ```
 
-See the [online documentation][online_docs] for more information.
-
-[online_docs]: http://hexdocs.pm/nebulex_distributed
-
 ## Testing
 
 Since this adapter uses support modules and shared tests from `Nebulex`,

lib/nebulex/adapters/multilevel.ex

@@ -229,7 +229,19 @@ defmodule Nebulex.Adapters.Multilevel do
         ]
       }
 
-  ## Caveats of multi-level adapter
+  ## Extended API
+
+  This adapter provides some additional convenience functions to the
+  `Nebulex.Cache` API.
+
+  ### `inclusion_policy/0,1`
+
+  Returns the inclusion policy of the cache.
+
+      iex> MyCache.inclusion_policy()
+      :inclusive
+
+  ## CAVEATS
 
   Because this adapter reuses other existing/configured adapters, it inherits
   all their limitations too. Therefore, it is highly recommended to check the

lib/nebulex/adapters/partitioned.ex

@@ -308,7 +308,7 @@ defmodule Nebulex.Adapters.Partitioned do
 
       MyCache.leave_cluster()
 
-  ## Caveats of partitioned adapter
+  ## CAVEATS
 
   For `c:Nebulex.Cache.get_and_update/3` and `c:Nebulex.Cache.update/4`,
   they both have a parameter that is the anonymous function, and it is compiled