From 1cdedd8d1f2f6a62f2588238b5f39d389614f4a9 Mon Sep 17 00:00:00 2001
From: Parker Selbert <parker@sorentwo.com>
Date: Mon, 24 Jun 2024 10:09:56 -0500
Subject: [PATCH] Split README and top level docs for admnonition

Github Markdown and ExDoc have different admonition syntaxes, which made
the Web+Pro tip look quoted and broken.
---
 README.md   | 15 ++++++---------
 lib/oban.ex | 25 ++++++++++++++++++++-----
 2 files changed, 26 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index b1c02f56..3a604a66 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@
 
 - [Features](#features)
 - [Oban Web+Pro](#oban-webpro)
-- [Usage](#usage)
+- Usage
   - [Installation](#installation)
   - [Requirements](#requirements)
   - [Running With SQLite3](#running-with-sqlite3)
@@ -133,21 +133,18 @@ orphaned due to crashes.
 [rdbms]: https://en.wikipedia.org/wiki/Relational_database#RDBMS
 [tele]: https://github.com/beam-telemetry/telemetry
 
-## Usage
+## Oban Web+Pro
 
-<!-- MDOC -->
-
-Oban is a robust job processing library which uses PostgreSQL or SQLite3 for persistence.
-
-> #### Oban Web+Pro {: .tip}
->
+> [!TIP]
 > A web dashboard for managing Oban, along with an official set of extensions, plugins, and
 > workers that expand what Oban is capable are available as licensed packages:
 > 
 > * [🧭 Oban Web](https://getoban.pro#oban-web)
 > * [🌟 Oban Pro](https://getoban.pro#oban-pro)
 > 
-> Learn more about prices and licensing Oban Web+Pro at [getoban.pro][pro].
+> Learn more at [getoban.pro][pro]!
+
+<!-- MDOC -->
 
 ## Requirements
 
diff --git a/lib/oban.ex b/lib/oban.ex
index cdcbf598..270b848b 100644
--- a/lib/oban.ex
+++ b/lib/oban.ex
@@ -1,12 +1,27 @@
 defmodule Oban do
   @external_resource readme = Path.join([__DIR__, "../README.md"])
 
-  @moduledoc readme
-             |> File.read!()
-             |> String.split("<!-- MDOC -->")
-             |> Enum.fetch!(1)
+  @doc_header """
+  Oban is a robust job processing library which uses PostgreSQL or SQLite3 for persistence.
 
-  @moduledoc since: "0.1.0"
+  > #### Oban Web+Pro {: .info}
+  >
+  > A web dashboard for managing Oban, along with an official set of extensions, plugins, and
+  > workers that expand what Oban is capable are available as licensed packages:
+  > 
+  > * [🧭 Oban Web](https://getoban.pro#oban-web)
+  > * [🌟 Oban Pro](https://getoban.pro#oban-pro)
+  > 
+  > Learn more at [getoban.pro][pro]!
+
+  """
+
+  @doc_footer readme
+              |> File.read!()
+              |> String.split("<!-- MDOC -->")
+              |> Enum.fetch!(1)
+
+  @moduledoc @doc_header <> @doc_footer
 
   use Supervisor