Minor cleanups and additions in docs

includes:
- add missing CUDA provider in the web docs,
- proxy_pool is enabled by default, move req. info to proxy_lib,
- add links in README.

Author: lukaszstolarczuk

README.md

@@ -122,11 +122,16 @@ List of options provided by CMake:
 
 ## Architecture: memory pools and providers
 
-A UMF memory pool is a combination of a pool allocator and a memory provider. A memory provider is responsible for coarse-grained memory allocations and management of memory pages, while the pool allocator controls memory pooling and handles fine-grained memory allocations.
+A UMF memory pool is a combination of a pool allocator and a memory provider. A memory provider is responsible for
+coarse-grained memory allocations and management of memory pages, while the pool allocator controls memory pooling
+and handles fine-grained memory allocations.
 
 Pool allocator can leverage existing allocators (e.g. jemalloc or tbbmalloc) or be written from scratch.
 
-UMF comes with predefined pool allocators (see include/pool) and providers (see include/provider). UMF can also work with user-defined pools and providers that implement a specific interface (see include/umf/memory_pool_ops.h and include/umf/memory_provider_ops.h).
+UMF comes with predefined pool allocators (see [`include/umf/pools`](include/umf/pools)) and providers
+(see [`include/umf/providers`](include/umf/providers)). UMF can also work with user-defined pools and
+providers that implement a specific interface (see [`include/umf/memory_pool_ops.h`](include/umf/memory_pool_ops.h)
+and [`include/umf/memory_provider_ops.h`](include/umf/memory_provider_ops.h)).
 
 More detailed documentation is available here: https://oneapi-src.github.io/unified-memory-framework/
 
@@ -152,6 +157,7 @@ a duplicate of another process's file descriptor (`pidfd_getfd(2)` is supported
 Permission to duplicate another process's file descriptor is governed by a ptrace access mode
 `PTRACE_MODE_ATTACH_REALCREDS` check (see `ptrace(2)`) that can be changed using
 the `/proc/sys/kernel/yama/ptrace_scope` interface in the following way:
+
 ```sh
 $ sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"
 ```
@@ -183,6 +189,7 @@ a duplicate of another process's file descriptor (`pidfd_getfd(2)` is supported
 Permission to duplicate another process's file descriptor is governed by a ptrace access mode
 `PTRACE_MODE_ATTACH_REALCREDS` check (see `ptrace(2)`) that can be changed using
 the `/proc/sys/kernel/yama/ptrace_scope` interface in the following way:
+
 ```sh
 $ sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"
 ```
@@ -203,7 +210,7 @@ Additionally, required for tests:
 
 #### DevDax memory provider (Linux only)
 
-A memory provider that provides memory from a device DAX (a character device file /dev/daxX.Y).
+A memory provider that provides memory from a device DAX (a character device file like `/dev/daxX.Y`).
 It can be used when large memory mappings are needed.
 
 ##### Requirements
@@ -249,8 +256,6 @@ This memory pool is distributed as part of libumf. It forwards all requests to t
 memory provider. Currently umfPoolRealloc, umfPoolCalloc and umfPoolMallocUsableSize functions
 are not supported by the proxy pool.
 
-To enable this feature, the `UMF_BUILD_SHARED_LIBRARY` option needs to be turned `ON`.
-
 #### Disjoint pool
 
 TODO: Add a description
@@ -326,6 +331,8 @@ Querying the latency value requires HMAT support on the platform. Calling `umfMe
 UMF provides the UMF proxy library (`umf_proxy`) that makes it possible
 to override the default allocator in other programs in both Linux and Windows.
 
+To enable this feature, the `UMF_BUILD_SHARED_LIBRARY` option needs to be turned `ON`.
+
 #### Linux
 
 In case of Linux it can be done without any code changes using the `LD_PRELOAD` environment variable:

scripts/docs_config/api.rst

@@ -58,6 +58,9 @@ supported by the Proxy Pool.
 
 Scalable Pool
 ------------------------------------------
+
+A oneTBB-based memory pool manager.
+
 .. doxygenfile:: pool_scalable.h
     :sections: define enum typedef func var
 
@@ -104,10 +107,18 @@ A memory provider that provides memory from L0 device.
 .. doxygenfile:: provider_level_zero.h
     :sections: define enum typedef func var
 
+CUDA Provider
+------------------------------------------
+
+A memory provider that provides memory from CUDA device.
+
+.. doxygenfile:: provider_cuda.h
+    :sections: define enum typedef func var
+
 DevDax Memory Provider
 ------------------------------------------
 
-A memory provider that provides memory from a device DAX (a character device file /dev/daxX.Y).
+A memory provider that provides memory from a device DAX (a character device file like /dev/daxX.Y).
 
 .. doxygenfile:: provider_devdax_memory.h
     :sections: define enum typedef func var