Add Incomplete_Pages

Author: Fernando-A-Rocha

web/astro.config.mjs

@@ -37,14 +37,17 @@ export default defineConfig({
 			disable404Route: true,
 			sidebar: [
 				{
-					label: 'Start here',
+					label: 'Welcome',
 					items: [
 						{
 							label: 'Introduction', link: '/',
 						},
 						{
 							label: 'How you can help', link: '/articles/How_you_can_help',
 						},
+						{
+							label: 'Incomplete Pages', link: '/Incomplete_Pages',
+						},
 					]
 				},
 				{

web/src/pages/Incomplete_Pages.astro

@@ -0,0 +1,57 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { getUnfinishedPages } from '@src/utils/general';
+
+const unfinishedFunctions = getUnfinishedPages('functions');
+const unfinishedEvents = getUnfinishedPages('events');
+---
+
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Incomplete Pages',
+    tableOfContents: false,
+}}>
+
+<p>The following pages are not finished, and need your attention! Please help complete the MTA Wiki.</p>
+<p><a href="https://github.com/multitheftauto/wiki.multitheftauto.com/blob/main/CONTRIBUTING.md"
+    class="guidelines-link">Contribution guidelines</a></p>
+
+<h3>Unfinished Function Pages</h3>
+<p>These functions (part of the MTA Lua API) are <strong>missing documentation or code examples</strong>:</p>
+<section>
+    <details>
+    <summary>Total: {unfinishedFunctions.length}</summary>
+    <ul>
+        {unfinishedFunctions.map((func) => (
+            <li>
+                <a href={`/reference/${func}`}>{func}</a>
+            </li>
+        ))}
+    </ul>
+    </details>
+</section>
+
+<h3>Unfinished Event Pages</h3>
+<p>These events (part of the MTA Lua API) are <strong>missing documentation or code examples</strong>:</p>
+<section>
+    <details>
+    <summary>Total: {unfinishedEvents.length}</summary>
+    <ul>
+        {unfinishedEvents.map((event) => (
+            <li>
+                <a href={`/reference/${event}`}>{event}</a>
+            </li>
+        ))}
+    </ul>
+    </details>
+</section>
+
+</StarlightPage>
+
+<style>
+    .guidelines-link {
+        font-size: 1.5rem;
+        color: var(--sl-color-orange);
+        font-weight: bold;
+    }
+</style>

web/src/utils/general.ts

@@ -1,7 +1,7 @@
 import { marked } from 'marked';
 import path from 'path';
-import { getFunctionsByTypeByCategory } from '@src/utils/functions';
-import { getEventsByTypeByCategory } from '@src/utils/events';
+import { getFunctionsByCategory, getFunctionsByTypeByCategory } from '@src/utils/functions';
+import { getEventsByCategory, getEventsByTypeByCategory } from '@src/utils/events';
 import { getElementsByCategory, getElementCategory } from '@src/utils/elements';
 
 import type { ImageMetadata } from 'astro';
@@ -199,3 +199,30 @@ export function getSeeAlsoLinksForItem(theItem: any): SeeAlsoLinkGroup[] {
   const allSeeAlso = [...new Set([...seeAlso, ...addToSeeAlso])];
   return getSeeAlsoLinksFromList(allSeeAlso);
 }
+
+export function getUnfinishedPages(pageType: 'functions' | 'events'): string[] {
+  const unfinishedPages: string[] = [];
+  const pagesByCategory = {
+    functions: getFunctionsByCategory(),
+    events: getEventsByCategory(),
+  };
+  for (const category in pagesByCategory[pageType]) {
+    const items = pagesByCategory[pageType][category];
+    for (const item of items) {
+      const data = item.data.shared || item.data.client || item.data.server || item.data;
+      // Check if item description contains 'NEEDS DOCUMENTATION'
+      if (data && data.description && data.description.includes('NEEDS DOCUMENTATION')) {
+        unfinishedPages.push(item.id);
+      } else {
+        // Check if the item has no code examples
+        const examples = item.data.shared?.examples || item.data.client?.examples || item.data.server?.examples || item.data.examples;
+        if (!examples || examples.length === 0) {
+          unfinishedPages.push(item.id);
+        }
+      }
+    }
+  }
+  // Sort alphabetically
+  unfinishedPages.sort((a, b) => a.localeCompare(b));
+  return unfinishedPages;
+}