Improve Docs

README.md

@@ -1,3 +1,5 @@
+<img align="right" src="https://raw.githubusercontent.com/erlef/oidcc/main/assets/logo.svg" width="150px">
+
 # oidcc
 
 [![EEF Security WG project](https://img.shields.io/badge/EEF-Security-black)](https://github.com/erlef/security-wg)
@@ -14,11 +16,12 @@ OpenID Connect client library for Erlang.
 <!--
 OpenID Certified by Jonatan Männchen at the Erlang Ecosystem Foundation for the
 basic and configuration profile of the OpenID Connect protocol. For details,
-check the [Conformance Documentation] (./conformance/HOWTO.md).
+check the [Conformance Documentation](https://github.com/erlef/oidcc/blob/main/conformance/HOWTO.md).
 
-![OpenID Connect Certified Logo](https://openid.net/wp-content/uploads/2023/01/image.png))
+![OpenID Connect Certified Logo](https://raw.githubusercontent.com/erlef/oidcc/main/assets/certified.svg)
 -->
 
+
 The refactoring for `v3` and the certification is funded as an
 [Erlang Ecosystem Foundation](https://erlef.org/) stipend entered by the
 [Security Working Group](https://erlef.org/wg/security).

lib/oidcc.ex

@@ -21,6 +21,7 @@ defmodule Oidcc do
   * `max_clock_skew` (default `0`) - Maximum allowed clock skew for JWT
     `exp` / `nbf` validation
   """
+  @moduledoc since: "3.0.0"
 
   @doc """
   Create Auth Redirect URL
@@ -41,6 +42,7 @@ defmodule Oidcc do
       ...>   )
 
   """
+  @doc since: "3.0.0"
   @spec create_redirect_url(
           provider_configuration_name :: GenServer.name(),
           client_id :: String.t(),
@@ -79,6 +81,7 @@ defmodule Oidcc do
       ...> # => {:ok, %Oidcc.Token{}}
 
   """
+  @doc since: "3.0.0"
   @spec retrieve_token(
           auth_code :: String.t(),
           provider_configuration_name :: GenServer.name(),
@@ -121,6 +124,7 @@ defmodule Oidcc do
       ...> # => {:ok, %Oidcc.Token{}}
 
   """
+  @doc since: "3.0.0"
   @spec refresh_token(
           refresh_token :: String.t(),
           provider_configuration_name :: GenServer.name(),
@@ -172,6 +176,7 @@ defmodule Oidcc do
       ...> # => {:ok, %Oidcc.TokenIntrospection{}}
 
   """
+  @doc since: "3.0.0"
   @spec introspect_token(
           access_token :: String.t() | Oidcc.Token.t(),
           provider_configuration_name :: GenServer.name(),
@@ -229,6 +234,7 @@ defmodule Oidcc do
       ...> # => {:ok, %{"sub" => "sub"}}
 
   """
+  @doc since: "3.0.0"
   @spec retrieve_userinfo(
           token :: Oidcc.Token.t(),
           provider_configuration_name :: GenServer.name(),
@@ -284,6 +290,7 @@ defmodule Oidcc do
       ...>   )
 
   """
+  @doc since: "3.0.0"
   @spec jwt_profile_token(
           subject :: String.t(),
           provider_configuration_name :: GenServer.name(),
@@ -328,6 +335,7 @@ defmodule Oidcc do
       ...>   )
 
   """
+  @doc since: "3.0.0"
   @spec client_credentials_token(
           provider_configuration_name :: GenServer.name(),
           client_id :: String.t(),

lib/oidcc/authorization.ex

@@ -2,6 +2,7 @@ defmodule Oidcc.Authorization do
   @moduledoc """
   Functions to start an OpenID Connect Authorization
   """
+  @moduledoc since: "3.0.0"
 
   alias Oidcc.ClientContext
 
@@ -31,6 +32,7 @@ defmodule Oidcc.Authorization do
       ...>     %{redirect_uri: "https://my.server/return"}
       ...>   )
   """
+  @doc since: "3.0.0"
   @spec create_redirect_url(
           client_context :: ClientContext.t(),
           opts :: :oidcc_authorization.opts()

lib/oidcc/client_context.ex

@@ -7,6 +7,7 @@ defmodule Oidcc.ClientContext do
   interface of `Oidcc`. In that case direct usage of this
   module is not needed.
   """
+  @moduledoc since: "3.0.0"
 
   use Oidcc.RecordStruct,
     internal_name: :context,
@@ -15,6 +16,7 @@ defmodule Oidcc.ClientContext do
 
   alias Oidcc.ProviderConfiguration
 
+  @typedoc since: "3.0.0"
   @type t() :: %__MODULE__{
           provider_configuration: ProviderConfiguration.t(),
           jwks: JOSE.JWK.t(),
@@ -47,6 +49,7 @@ defmodule Oidcc.ClientContext do
       ...>     "client_Secret"
       ...>   )
   """
+  @doc since: "3.0.0"
   @spec from_configuration_worker(
           provider_name :: GenServer.name(),
           client_id :: String.t(),
@@ -86,6 +89,7 @@ defmodule Oidcc.ClientContext do
       ...>     "client_Secret"
       ...>   )
   """
+  @doc since: "3.0.0"
   @spec from_manual(
           configuration :: ProviderConfiguration.t(),
           jwks :: JOSE.JWK.t(),

lib/oidcc/provider_configuration.ex

@@ -50,6 +50,7 @@ defmodule Oidcc.ProviderConfiguration do
 
   #{telemetry_docs()}
   """
+  @moduledoc since: "3.0.0"
 
   use Oidcc.RecordStruct,
     internal_name: :configuration,
@@ -63,6 +64,7 @@ defmodule Oidcc.ProviderConfiguration do
   * https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
   * https://datatracker.ietf.org/doc/html/draft-jones-oauth-discovery-01#section-4.1
   """
+  @typedoc since: "3.0.0"
   @type t() :: %__MODULE__{
           issuer: :uri_string.uri_string(),
           authorization_endpoint: :uri_string.uri_string(),
@@ -119,6 +121,7 @@ defmodule Oidcc.ProviderConfiguration do
       ...>   _expiry
       ...> }} = Oidcc.ProviderConfiguration.load_configuration("https://accounts.google.com")
   """
+  @doc since: "3.0.0"
   @spec load_configuration(
           issuer :: :uri_string.uri_string(),
           opts :: :oidcc_provider_configuration.opts()
@@ -140,6 +143,7 @@ defmodule Oidcc.ProviderConfiguration do
       iex> {:ok, {%JOSE.JWK{}, _expiry}} =
       ...>   Oidcc.ProviderConfiguration.load_jwks("https://www.googleapis.com/oauth2/v3/certs")
   """
+  @doc since: "3.0.0"
   @spec load_jwks(
           jwks_uri :: :uri_string.uri_string(),
           opts :: :oidcc_provider_configuration.opts()
@@ -166,6 +170,7 @@ defmodule Oidcc.ProviderConfiguration do
       ...> {:ok, %ProviderConfiguration{issuer: "https://accounts.google.com"}} =
       ...>   Oidcc.ProviderConfiguration.decode_configuration(decoded_json)
   """
+  @doc since: "3.0.0"
   @spec decode_configuration(configuration :: map()) ::
           {:ok, t()} | {:error, :oidcc_provider_configuration.error()}
   def decode_configuration(configuration) do