Modify the bundle specific documentations

Author: leeyi45

docs/src/lib/dev/devdocs.data.ts

@@ -2,14 +2,6 @@
 title: Modules Developer Docs
 ---
 
-<script setup>
-  import { data } from './devdocs.data.ts'
-</script>
+# Modules Developer Documentation
 
-<h1>Bundles Developer Documentation</h1>
-<p>This the index page for bundles that have documentation intended for developers working with them</p>
-<ul>
-  <li v-for="doc of data">
-    <a :href="doc.url">{{ doc.frontmatter.title }}</a>
-  </li>
-</ul>
+Refer to the sidebar to see the list of modules that have developer documentation available.

docs/src/lib/dev/index.md

@@ -33,8 +33,7 @@ If you have more complex documentation needs, you can follow the instructions in
 
 ### 2. As a collection of Markdown files located [here](../../../lib/dev):
 
-Within the `dev` folder, markdown files are collated and displayed in the index page. Each
-markdown file/folder structure represents a separate bundle.
+Within the `dev` folder, each markdown file/folder structure represents a separate bundle.
 
 For example:
 ```dirtree
@@ -53,12 +52,31 @@ children:
   comment: Add your own bundle's documentation!
 ```
 
+You can of course use a directory structure as well:
+```dirtree
+name: dev
+children:
+- name: index.md
+  comment: Index Page
+
+- name: curve.md
+  comment: Documentation for the curve bundle
+
+- name: game.md
+  comment: Documentation for the game bundle
+
+- name: your_bundle
+  children:
+  - index.md
+  - docs.md
+```
+
 ### 3. Throughout Your Code
 
 Especially when your bundle intentionally breaks conventions or rules, or when you need to do
 something unconventional, you should leave comments in your source code detailing why.
 
-For example, the `communication` bundle uses the `mqtt` bundle but doesn't use its main
+In the example below, the `communication` bundle uses the `mqtt` bundle but doesn't use its main
 export. The comment explains why the alternate import is being used.
 ```ts
 import { connect, type MqttClient, type QoS } from 'mqtt/dist/mqtt';

docs/src/modules/2-bundle/5-documentation/2-dev.md

@@ -6,6 +6,7 @@ import markdown from '@eslint/markdown';
 import saLintPlugin from '@sourceacademy/lint-plugin';
 import stylePlugin from '@stylistic/eslint-plugin';
 import vitestPlugin from '@vitest/eslint-plugin';
+import { defineConfig } from 'eslint/config';
 import * as importPlugin from 'eslint-plugin-import';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
 import * as mdx from 'eslint-plugin-mdx';
@@ -19,7 +20,7 @@ import tseslint from 'typescript-eslint';
 const todoTreeKeywordsWarning = ['TODO', 'TODOS', 'TODO WIP', 'FIXME', 'WIP'];
 const todoTreeKeywordsAll = [...todoTreeKeywordsWarning, 'NOTE', 'NOTES', 'LIST'];
 
-export default tseslint.config(
+export default defineConfig(
   {
     name: 'Global Ignores',
     ignores: [
@@ -57,7 +58,6 @@ export default tseslint.config(
     }),
     language: 'markdown/gfm',
     languageOptions: {
-      // @ts-expect-error typescript eslint doesn't recognize this property
       frontmatter: 'yaml'
     },
     plugins: { markdown },
@@ -95,6 +95,7 @@ export default tseslint.config(
     extends: [ymlPlugin.configs['flat/recommended']],
     files: ['**/*.yml', '**/*.yaml'],
     plugins: {
+      // @ts-expect-error yml plugin causes errors
       yml: ymlPlugin
     },
     rules: {