diff --git a/docs/api/assets/anchor.js b/docs/assets/anchor.js similarity index 100% rename from docs/api/assets/anchor.js rename to docs/assets/anchor.js diff --git a/docs/api/assets/bass-addons.css b/docs/assets/bass-addons.css similarity index 100% rename from docs/api/assets/bass-addons.css rename to docs/assets/bass-addons.css diff --git a/docs/api/assets/bass.css b/docs/assets/bass.css similarity index 100% rename from docs/api/assets/bass.css rename to docs/assets/bass.css diff --git a/docs/api/assets/fonts/EOT/SourceCodePro-Bold.eot b/docs/assets/fonts/EOT/SourceCodePro-Bold.eot similarity index 100% rename from docs/api/assets/fonts/EOT/SourceCodePro-Bold.eot rename to docs/assets/fonts/EOT/SourceCodePro-Bold.eot diff --git a/docs/api/assets/fonts/EOT/SourceCodePro-Regular.eot b/docs/assets/fonts/EOT/SourceCodePro-Regular.eot similarity index 100% rename from docs/api/assets/fonts/EOT/SourceCodePro-Regular.eot rename to docs/assets/fonts/EOT/SourceCodePro-Regular.eot diff --git a/docs/api/assets/fonts/LICENSE.txt b/docs/assets/fonts/LICENSE.txt similarity index 100% rename from docs/api/assets/fonts/LICENSE.txt rename to docs/assets/fonts/LICENSE.txt diff --git a/docs/api/assets/fonts/OTF/SourceCodePro-Bold.otf b/docs/assets/fonts/OTF/SourceCodePro-Bold.otf similarity index 100% rename from docs/api/assets/fonts/OTF/SourceCodePro-Bold.otf rename to docs/assets/fonts/OTF/SourceCodePro-Bold.otf diff --git a/docs/api/assets/fonts/OTF/SourceCodePro-Regular.otf b/docs/assets/fonts/OTF/SourceCodePro-Regular.otf similarity index 100% rename from docs/api/assets/fonts/OTF/SourceCodePro-Regular.otf rename to docs/assets/fonts/OTF/SourceCodePro-Regular.otf diff --git a/docs/api/assets/fonts/TTF/SourceCodePro-Bold.ttf b/docs/assets/fonts/TTF/SourceCodePro-Bold.ttf similarity index 100% rename from docs/api/assets/fonts/TTF/SourceCodePro-Bold.ttf rename to docs/assets/fonts/TTF/SourceCodePro-Bold.ttf diff --git a/docs/api/assets/fonts/TTF/SourceCodePro-Regular.ttf b/docs/assets/fonts/TTF/SourceCodePro-Regular.ttf similarity index 100% rename from docs/api/assets/fonts/TTF/SourceCodePro-Regular.ttf rename to docs/assets/fonts/TTF/SourceCodePro-Regular.ttf diff --git a/docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff b/docs/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff similarity index 100% rename from docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff rename to docs/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff diff --git a/docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff b/docs/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff similarity index 100% rename from docs/api/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff rename to docs/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff diff --git a/docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff b/docs/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff similarity index 100% rename from docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff rename to docs/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff diff --git a/docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff b/docs/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff similarity index 100% rename from docs/api/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff rename to docs/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff diff --git a/docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 b/docs/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 similarity index 100% rename from docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 rename to docs/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 diff --git a/docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 b/docs/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 similarity index 100% rename from docs/api/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 rename to docs/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 diff --git a/docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 b/docs/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 similarity index 100% rename from docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 rename to docs/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 diff --git a/docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 b/docs/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 similarity index 100% rename from docs/api/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 rename to docs/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 diff --git a/docs/api/assets/fonts/source-code-pro.css b/docs/assets/fonts/source-code-pro.css similarity index 100% rename from docs/api/assets/fonts/source-code-pro.css rename to docs/assets/fonts/source-code-pro.css diff --git a/docs/api/assets/github.css b/docs/assets/github.css similarity index 100% rename from docs/api/assets/github.css rename to docs/assets/github.css diff --git a/docs/api/assets/site.js b/docs/assets/site.js similarity index 100% rename from docs/api/assets/site.js rename to docs/assets/site.js diff --git a/docs/api/assets/split.css b/docs/assets/split.css similarity index 100% rename from docs/api/assets/split.css rename to docs/assets/split.css diff --git a/docs/api/assets/split.js b/docs/assets/split.js similarity index 100% rename from docs/api/assets/split.js rename to docs/assets/split.js diff --git a/docs/api/assets/style.css b/docs/assets/style.css similarity index 100% rename from docs/api/assets/style.css rename to docs/assets/style.css diff --git a/docs/api/config.yml b/docs/config.yml similarity index 100% rename from docs/api/config.yml rename to docs/config.yml diff --git a/docs/api/index.html b/docs/index.html similarity index 95% rename from docs/api/index.html rename to docs/index.html index eb372e9..ce61239 100644 --- a/docs/api/index.html +++ b/docs/index.html @@ -663,7 +663,7 @@

- + src/index.js @@ -740,10 +740,7 @@

options (Object? = undefined) - - +
@@ -900,7 +897,7 @@

- + src/index.js @@ -1019,10 +1016,7 @@

options (Object? = undefined) -
    -
  • -
- +

@@ -1125,7 +1119,7 @@

- + src/index.js @@ -1203,10 +1197,7 @@

options (Object? = undefined) -
    -
  • -
- +

@@ -1309,7 +1300,7 @@

- + src/evaluator.js @@ -1387,7 +1378,7 @@

- + src/evaluator.js @@ -1506,7 +1497,7 @@

- + src/evaluators/readability-evaluator.js @@ -1622,7 +1613,7 @@

- + src/system.js @@ -1698,7 +1689,7 @@

- + src/system.js @@ -1805,7 +1796,7 @@

- + src/systems/generative-elastic-system.js @@ -2055,7 +2046,7 @@

- + src/systems/generative-elastic-system.js @@ -2173,7 +2164,7 @@

- + src/user.js @@ -2251,7 +2242,7 @@

- + src/user.js @@ -2360,7 +2351,7 @@

- + src/user.js @@ -2475,7 +2466,7 @@

- + src/users/static-user.js @@ -2622,7 +2613,7 @@

- + src/llm.js @@ -2697,7 +2688,7 @@

- + src/llm.js @@ -2777,7 +2768,7 @@

- + src/llm.js @@ -2857,7 +2848,7 @@

- + src/llm.js @@ -2937,7 +2928,7 @@

- + src/llm.js @@ -3035,7 +3026,7 @@

- + src/llm.js @@ -3164,7 +3155,7 @@

- + src/logbook.js @@ -3252,7 +3243,7 @@

- + src/logbook.js @@ -3350,7 +3341,7 @@

- + src/templates.js @@ -3400,7 +3391,7 @@

- + src/templates.js @@ -3524,7 +3515,7 @@

- + src/templates.js @@ -3604,7 +3595,7 @@

- + src/templates.js @@ -3695,7 +3686,7 @@

- + src/templates.js @@ -3802,7 +3793,7 @@

- + src/index.js @@ -3903,7 +3894,7 @@

- + src/evaluator.js @@ -3975,7 +3966,7 @@

- + src/evaluator.js @@ -4025,7 +4016,7 @@

- + src/evaluator.js @@ -4083,7 +4074,7 @@

- + src/evaluator.js @@ -4151,7 +4142,7 @@

- + src/llm.js @@ -4234,7 +4225,7 @@

- + src/logbook.js @@ -4319,7 +4310,7 @@

- + src/logbook.js @@ -4382,7 +4373,7 @@

- + src/logbook.js @@ -4445,7 +4436,7 @@

- + src/logbook.js @@ -4508,7 +4499,7 @@

- + src/logbook.js @@ -4580,7 +4571,7 @@

- + src/logbook.js @@ -4661,7 +4652,7 @@

- + src/logbook.js @@ -4727,7 +4718,7 @@

- + src/logbook.js @@ -4793,7 +4784,7 @@

- + src/logbook.js @@ -4867,7 +4858,7 @@

- + src/index.js @@ -4948,7 +4939,7 @@

- + src/system.js @@ -5020,7 +5011,7 @@

- + src/system.js @@ -5070,7 +5061,7 @@

- + src/system.js @@ -5128,7 +5119,7 @@

- + src/system.js @@ -5186,7 +5177,7 @@

- + src/system.js @@ -5254,7 +5245,7 @@

- + src/index.js @@ -5326,7 +5317,7 @@

- + src/user.js @@ -5407,7 +5398,7 @@

- + src/user.js @@ -5457,7 +5448,7 @@

- + src/user.js @@ -5515,7 +5506,7 @@

- + src/user.js diff --git a/package.json b/package.json index a68b181..73df74c 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "simulation-server": "bin/simulation-server.js" }, "scripts": { - "doc": "documentation build -f html -o docs/api/ --github --config docs/api/config.yml" + "doc": "documentation build -f html -o docs/ --github --config docs/config.yml" }, "repository": { "type": "git", diff --git a/src/index.js b/src/index.js index b358a83..5ce0cff 100644 --- a/src/index.js +++ b/src/index.js @@ -65,7 +65,7 @@ const defaultLogCallback = entry => console.error(JSON.stringify(entry)); * either one of the standard classes of GenIRSim or one in `additionalSystems` * @param {number} [configuration.maxTurns] - The maximum number of user turns * to simulate (default: 3) - * @param {Object} [options] - + * @param {Object} [options] * @param {function} [options.logCallback] - The function to consume all * {@link LogbookEntry} of the simulation * @param {Object} [options.additionalUsers] - Object that contains non-standard @@ -155,7 +155,7 @@ async function evaluateTurn(instantiatedEvaluators, logbook, simulation, userTur * in the the constructor and (2) has a property `class` that is the name of the * evaluator class, either one of the standard classes of GenIRSim or one in * `additionalEvaluators` - * @param {Object} [options] - + * @param {Object} [options] * @param {function} [options.logCallback] - The function to consume all * {@link LogbookEntry} of the evaluation * @param {Object} [options.additionalEvaluators] - Object that contains @@ -211,7 +211,7 @@ export async function evaluate(simulation, configuration, options = undefined) { * simulation, see {@link simulate} * @param {Object} configuration.evaluation - The configuration for the * evaluation, see {@link evaluate} - * @param {Object} [options] - + * @param {Object} [options] * @param {function} [options.logCallback] - The function to consume all * {@link LogbookEntry} of the simulation and evaluation * @param {Object} [options.additionalUsers] - Object that contains non-standard {User}