fixup!

Author: avivkeller

packages/core/src/generators/json-all/schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://doc-kit.nodejs.org/schemas/api-doc-all/1.0.0.json",
+  "$id": "https://doc-kit.nodejs.org/schemas/api-doc-all/1.0.1.json",
   "title": "Bundle",
-  "description": "Every document of a documentation set, as emitted by the doc-kit `json-all` generator, in index order.",
+  "description": "Every document of a documentation set, as emitted by the doc-kit `json-all` generator",
   "type": "object",
   "properties": {
     "$schema": {
@@ -12,7 +12,7 @@
     "documents": {
       "type": "array",
       "items": {
-        "$ref": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.0.json"
+        "$ref": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json"
       },
       "description": "The documents, in the order of the configured index, then by id."
     }

packages/core/src/generators/json-all/types.d.ts

@@ -1,7 +1,7 @@
 import type { Document } from '../json/generated/schema';
 
 /**
- * Every document of a documentation set, in index order.
+ * Every document of a documentation set
  */
 export interface Bundle {
   /** The URL of the schema the bundle conforms to */

packages/core/src/generators/json-simple/generate.mjs

@@ -21,8 +21,6 @@ export async function generate(input) {
   );
 
   if (config.output) {
-    // Writes all the API docs stringified content into one file
-    // Note: The full JSON generator in the future will create one JSON file per top-level API doc file
     await writeJSON(join(config.output, 'api-docs.json'), input, config.minify);
   }
 

packages/core/src/generators/json/README.md

@@ -12,7 +12,7 @@ carries in `$schema`, and shipped with the package as
 npx @doc-kit/cli generate -t json -i "doc/api/*.md" -o out
 ```
 
-Files keep the input's directory layout: `doc/api/fs.md` becomes `out/fs.json`.
+Files keep the input's directory layout: `doc/api/some/fs.md` becomes `out/some/fs.json`.
 
 ## Configuring
 
@@ -129,7 +129,7 @@ Every node also has:
 }
 ```
 
-- A signature's `parameters` are the ones the heading declares, in order,
+- A signature's `parameters` are the ones the heading declares,
   described by the typed list under it. `optional` is set for parameters
   bracketed in the heading or documented with a default; `rest` for
   `...args`. `properties` are the nested list items: the properties of an

packages/core/src/generators/json/constants.mjs

@@ -1,7 +1,7 @@
 'use strict';
 
 // See the `version` in schema.json. These values should be in sync.
-export const SCHEMA_VERSION = '1.0.0';
+export const SCHEMA_VERSION = '1.0.1';
 
 // Where a schema version is published.
 export const SCHEMA_URL =

packages/core/src/generators/json/generated/schema.d.ts

@@ -159,7 +159,7 @@ export interface Entry {
    */
   summary: string;
   /**
-   * The fenced code blocks in the body, in order. They remain in the description too.
+   * The fenced code blocks in the body. They remain in the description too.
    */
   examples: Example[];
 }

packages/core/src/generators/json/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.0.json",
+  "$id": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json",
   "title": "Document",
   "description": "One API documentation source file, as emitted by the doc-kit `json` generator. The file is the root of a tree of nodes, one per heading, in document order.",
   "allOf": [
@@ -326,7 +326,7 @@
         "examples": {
           "type": "array",
           "items": { "$ref": "#/definitions/Example" },
-          "description": "The fenced code blocks in the body, in order. They remain in the description too."
+          "description": "The fenced code blocks in the body. They remain in the description too."
         }
       },
       "required": [

packages/core/src/generators/json/utils/markdown.mjs

@@ -37,7 +37,7 @@ export const inlineToMarkdown = (nodes, mdx) =>
     : blocksToMarkdown([createTree('paragraph', nodes)], mdx);
 
 /**
- * Collects the fenced code blocks of a body, in order.
+ * Collects the fenced code blocks of a body
  *
  * @param {Array<import('mdast').RootContent>} nodes
  * @returns {Array<import('../types').Example>}