fix (docs): workaround for mintlify breaking our docs again (#3436)
### **PR Type**
Bug fix, Documentation
___
### **Description**
- Fix Mintlify documentation breaking issue
- Update file naming convention for JWKS endpoint
- Adjust docs.json to reflect new file name
- Add metadata to JWKS endpoint documentation file
___
### Diagram Walkthrough
```mermaid
flowchart LR
A["Mintlify breaking issue"] --> B["File renaming"]
B --> C["docs.json update"]
B --> D["Metadata addition"]
C --> E["Fixed documentation"]
D --> E
```
<details> <summary><h3> File Walkthrough</h3></summary>
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Bug
fix</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>docs.json</strong><dd><code>Update JWKS endpoint file
reference in docs.json</code>
</dd></summary>
<hr>
docs/docs.json
<ul><li>Updated file path for JWKS endpoint documentation<br> <li>
Changed <code>get-.well-known-jwks.json</code> to
<code>get-.well-known-jwks_json</code></ul>
</details>
</td>
<td><a
href="https://github.com/nhost/nhost/pull/3436/files#diff-873ce17c654718debe2fe308a2f2279bde8663686423c51f97fab2dd0722b8d9">+1/-1</a>
</td>
</tr>
</table></td></tr><tr><td><strong>Documentation</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>get-.well-known-jwks_json.mdx</strong><dd><code>Add
metadata to JWKS endpoint documentation file</code>
</dd></summary>
<hr>
docs/reference/auth/get-.well-known-jwks_json.mdx
<ul><li>Added frontmatter metadata to the file<br> <li> Included title
and OpenAPI reference for the JWKS endpoint</ul>
</details>
</td>
<td><a
href="https://github.com/nhost/nhost/pull/3436/files#diff-70bc360afe951a74a46fadda220916c5248dde71aeb2b99e2d641e748d501524">[link]</a>
</td>
</tr>
</table></td></tr></tr></tbody></table>
</details>
___
This commit is contained in:
5
.changeset/curvy-spoons-try.md
Normal file
5
.changeset/curvy-spoons-try.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@nhost/docs': patch
|
||||
---
|
||||
|
||||
fix: workaround for mintlify breaking our docs again
|
||||
@@ -249,7 +249,7 @@
|
||||
"group": "Authentication",
|
||||
"icon": "user-check",
|
||||
"pages": [
|
||||
"reference/auth/get-.well-known-jwks.json",
|
||||
"reference/auth/get-.well-known-jwks_json",
|
||||
"reference/auth/post-elevate-webauthn",
|
||||
"reference/auth/post-elevate-webauthn-verify",
|
||||
"reference/auth/get-healthz",
|
||||
|
||||
Reference in New Issue
Block a user