Merge pull request #503 from kinde-oss/docs/frontmatter-contributions

Updated contribution guide and fixed an infinite loop

Author: alex72508

astro.config.mjs

@@ -69,8 +69,6 @@ export default defineConfig({
       "/billing/about-billing/about-billing/",
     "/build/":
       "/build/applications/about-applications/",
-    "/contribute/":
-      "/contribute/",
     "/design/":
       "/design/brand/global-brand-defaults/",
     "/developer-tools/":

customHttp.yml

@@ -44,7 +44,8 @@ customHeaders:
           'sha256-8JLcQFZQruxl3jMUwogr3y5/GMmZPAc+j2mNi7gywmw='
           'sha256-w78n7W12c94ck4KhBCBA4NrjqkbDvSutqee+u+no0Tg='
           'sha256-/4BQzbQ0kgR1l13wtSM3rZ7nSvyV3PX/ShEfhZA1WoQ='
-          'sha256-zB5rUhTjHzt+r/RjhhI8CyMb5Y63k+J7ICVfQ7iHJqA=' 'self'
+          'sha256-zB5rUhTjHzt+r/RjhhI8CyMb5Y63k+J7ICVfQ7iHJqA='
+          'sha256-fFmtUWM/kGeUru+1rcCArLmnXKoEjis5I/dYQkZA+HM=' 'self'
           widgets.kinde.com kinde.com
           https://cdn.jsdelivr.net/npm/@scalar/[email protected]/dist/browser/standalone.min.js
       - key: Strict-Transport-Security

src/content/docs/contribute/index.mdx

@@ -170,56 +170,67 @@ This helps us recognize and prioritize requests.
 This section describes some of our styles, elements, and conventions for docs content.
 
 ### Frontmatter
+The header/metadata part of the content helps the article appearing correctly in docs. It is also important for external AI tools and search optimization. 
 
-The header/metadata part of the content is critical to the article appearing correctly in docs.
-
-#### <span class="text-lg font-bold">`title (required)`</span>
-
-**type:** `string`
-
-You must provide a title for every page. This will be displayed at the top of the page, in browser tabs, and in page metadata.
+Copy the whole example below into the top of any new topic. And complete the required sections. Complete optional sections if you want.
 
 ```md title="src/content/docs/developer-tools/about/our-sdks.mdx"
 ---
-title: Kinde SDKs
+page_id: 
+title: 
+description: "description"
+sidebar:
+  order: 
+relatedArticles:
+  - 
+  - 
+app_context:
+  - m: 
+    s: 
+topics:
+  - 
+  - 
+  - 
+sdk: []
+languages: []
+audience: 
+complexity: 
+keywords:
+  - 
+  - 
+  - 
+  - 
+  - 
+updated: yyyy-mm-dd
+featured: 
+deprecated: 
+ai-summary: 
 ---
 ```
 
-#### <span class="text-lg font-bold">`page_id (required)`</span>
+#### Required Fields
 
-**type:** `uuid`
+**`title`** (string) - You must provide a title for every page. This will be displayed at the top of the page, in browser tabs, and in page metadata.
 
-This is the internal unique `id` for the article. This will be used when referencing other articles within the `relatedArticles` frontmatter. You can use our [online UUID generator tool](https://kinde.com/tools/online-uuid-generator/) to use as the `page_id`.
+**`page_id`** (uuid) - This is the internal unique `id` for the article. This will be used when referencing other articles within the `relatedArticles` frontmatter. You can use our [online UUID generator tool](https://kinde.com/tools/online-uuid-generator/) to use as the `page_id`.
 
-```md title="src/content/docs/developer-tools/about/our-sdks.mdx"
----
-title: Kinde SDKs
-page_id: 684fc526-a338-4a67-9af6-742a39b66aff
----
-```
+**`description`** (string) - A brief description of the article content, used for SEO and metadata.
 
-#### <span class="text-lg font-bold">`order` (optional)</span>
+**`keywords`** (array) - Array of keywords for search optimization.
 
-<Aside>
+#### Optional Fields
 
-Providing the `order` frontmatter is completely optional and will be treated as a hint for us to where to place the file. We may update the article’s `order` upon further review.
+**`order`** (number) - Control the order of this article when sorting an autogenerated group of links under a specific topic or subtopic. Lower numbers are displayed higher up in the link group. Providing the `order` frontmatter is completely optional and will be treated as a hint for us to where to place the file. We may update the article's `order` upon further review.
 
-</Aside>
+**`topics`** (array) - Array of topic tags that help categorize the content.
 
-**type:** `number`
+**`sdk`** (array) - Array of SDKs that are relevant to this article. Use `[]` for no SDKs or `null` for not applicable.
 
-Control the order of this article when sorting an autogenerated group of links under a specific topic or subtopic. Lower numbers are displayed higher up in the link group.
+**`languages`** (array) - Array of programming languages covered in the article.
 
-```md title="src/content/docs/developer-tools/about/our-sdks.mdx"
----
-title: Kinde SDKs
-page_id: 684fc526-a338-4a67-9af6-742a39b66aff
-sidebar:
-  order: 1
----
-```
+**`ai-summary`** (string) - A summary of the article content for AI processing and search. Can be same as description.
 
-<Divider />
+**`relatedArticles`** (array) - Array of page IDs for related articles that should be displayed at the bottom of the page.
 
 ### Code samples