Refactor global docs, schemas reference, and API reference for independent versioning

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
           node-version: '22.x'
 
       - name: Install dependencies
-        run: npm ci
+        run: npm install
 
       - name: Determine commit range
         id: commit_range
@@ -70,7 +70,7 @@ jobs:
           node-version: '22.x'
 
       - name: Install
-        run: npm ci --include=dev
+        run: npm install --include=dev
 
       - name: Build
         run: npm run build
@@ -156,14 +156,14 @@ jobs:
         run: npm install
         working-directory: ./
 
+      - name: Generate schema documentation
+        run: npm run docs:schemamarkdown
+        working-directory: ./
+
       - name: Install docusaurus dependencies
         run: npm install
         working-directory: ./docusaurus
 
-      - name: Generate schema documentation
-        run: npm run gendocs
-        working-directory: ./docusaurus
-
       - name: Build Docusaurus site
         run: npm run build
         working-directory: ./docusaurus

.gitignore

@@ -1,5 +1,5 @@
-# auto-generated schema documentation
-docusaurus/docs/reference/schemas/
+# Project maintenance is performed using a private registry, therefore package-lock.json will contain erroneous artifacts that should not be committed
+package-lock.json
 
 # TypeScript artifacts
 *.d.ts

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright [2025] [The MITRE Corporation]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

docusaurus/.gitignore

@@ -1,3 +1,12 @@
+# Project maintenance is performed using a private registry, therefore package-lock.json will contain erroneous artifacts that should not be committed
+package-lock.json
+
+# auto-generated schema documentation
+schemas/sdo/
+schemas/sro/
+schemas/smo/
+schemas/attack-concept-table.mdx
+
 # Dependencies
 /node_modules
 

docusaurus/README.md

@@ -8,6 +8,8 @@ The automation is handled by the `generate-docs.sh` script, which processes each
 in the schema directory and uses the `zod2md` library to convert to Markdown. The output Markdown
 files are stored in the `docs/` directory.
 
+The Docusaurus site is configured and structured for ["Docs Multi-Instance"](https://docusaurus.io/docs/docs-multi-instance) to host the global docs content, schemas reference, and API reference as distinct sets of documentation (each set is its own plugin). The Schemas reference and API reference are each [versioned](https://docusaurus.io/docs/versioning) independently, while the main docs content is un-versioned. Be sure to adhere to Docusaurus's [recommended practices](https://docusaurus.io/docs/versioning#recommended-practices) for versioning.
+
 ## Setup
 
 ### Requirements
@@ -41,16 +43,45 @@ $ npm run start
 
 1. Build the static files
 
+    ```bash
+    $ npm run build
+    ```
+
+2. Serve contents
+
+    ```bash
+    $ npm run serve
+    ```
+
+## Taging a new version
+
+The following command will create a new version of the specified set of documentation (e.g. `schemas` or `api`) from its respective "current version" files. 
+
 ```bash
-$ npm run build
+$ npm run docusaurus docs:version:<pluginId> <new_version>
 ```
 
-2. Serve contents
+For example, to tag a new version of the `schemas` or `api` docs:
 
 ```bash
-$ npm run serve
+# Tag schemas doc version 4.4.1
+$ npm run docusaurus docs:version:api 4.4.1
+
+# Tag schemas doc version 3.3.0
+$ npm run docusaurus docs:version:schemas: 3.3.0
 ```
 
+### Versioned Docs Multi-Instance File Structure
+
+The default plugin instance, `docs`, contains our global docs content and is unversioned uses these paths:
+
+The `schemas` and `api` plugin instances use these paths:
+- `docusaurus/[pluginId]/` - Current Version docs folder
+- `docusaurus/sidebars[pluginId].ts` - Current Version sidebar
+- `docusaurus/[pluginId]_versions.json` - Lists other versions
+- `docusaurus/[pluginId]_versioned_docs/` - Contains other versions docs folders
+- `docusaurus/[pluginId]_versioned_sidebars/` - Contains other versions sidebars
+
 ## Troubleshooting
 
 To clear the site's generated assets, caches, and build artifacts:

docusaurus/api/index.mdx

@@ -0,0 +1,12 @@
+import WorkInProgressNotice from '@site/src/components/WorkInProgressNotice';
+
+# API Overview
+
+<WorkInProgressNotice />
+
+**Complete documentation for all ATT&CK Data Model classes and functions**
+
+The ATT&CK Data Model provides a comprehensive TypeScript API for working with MITRE ATT&CK data.
+This reference section documents all public classes, methods, and functions available in the library.
+
+---