Skip to content

Commit

Permalink
Cleanup mainpage and README.md to match style
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Collins <[email protected]>
  • Loading branch information
benmcollins committed Jan 9, 2025
1 parent 774f40a commit f4504a9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ on:
- ".github/**"
- "images/**"
- ".gitignore"
- "*.md"
pull_request:
branches: [ "master" ]
paths-ignore:
- "doxygen/**"
- ".github/**"
- "images/**"
- ".gitignore"
- "*.md"

jobs:
build-macos:
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

[![maClara](https://img.shields.io/badge/Sponsored%20by-maClara%2C%20LLC-blue?style=plastic&logoColor=blue)](https://maclara-llc.com)

> [!WARNING] The current LibJWT code is under heavy reconstruction and is changing
> [!WARNING]
> The current LibJWT code is under heavy reconstruction and is changing
> wildly from the API and ABI of v2 and prior. There's still a lot going on here,
> and there are no guarantees that this new API is set in stone. Users beware.
Expand Down
20 changes: 11 additions & 9 deletions doxygen/mainpage.dox
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
@mainpage Welcome to LibJWT

@warning The current LibJWT code is under heavy reconstruction and is changing
wildly from the API and ABI of v2 and prior. There's still a lot going on here,
and there are no guarantees that this new API is set in stone. Users beware. If
you want to see the older documentation,
[here's the latest](https://libjwt.io/stable)
> [!WARNING]
> The current LibJWT code is under heavy reconstruction and is changing
> wildly from the API and ABI of v2 and prior. There's still a lot going on here,
> and there are no guarantees that this new API is set in stone. Users beware. If
> you want to see the older documentation,
> [here's the latest](https://libjwt.io/stable)

@section standards \emoji :bulb: Supported Standards

Expand All @@ -15,10 +16,11 @@ Standard | RFC | Description
``JWS`` and ``JWE`` | @rfc{7518} | Specific types of JWT
``JWK`` and ``JWKS`` | @rfc{7517} | JSON Web Keys and Sets

@note Throughout this documentation you will see links such as the ones
above to RFC documents. These are relevant to that particular part of the
library and are helpful to understand some of the specific standards that
shaped the development of LibJWT.
> [!NOTE]
> Throughout this documentation you will see links such as the ones
> above to RFC documents. These are relevant to that particular part of the
> library and are helpful to understand some of the specific standards that
> shaped the development of LibJWT.

@section building \emoji :construction: Build Prerequisites

Expand Down

0 comments on commit f4504a9

Please sign in to comment.