@eagleoutice/flowr 2.7.0 → 2.7.2

package/documentation/wiki-dataflow-graph.js

@@ -739,7 +739,7 @@ class WikiDataflowGraph extends doc_maker_1.DocMaker {
         return `
 This page briefly summarizes flowR's dataflow graph, represented by the ${ctx.link(graph_1.DataflowGraph)} class within the code.
 In case you want to manually build such a graph (e.g., for testing), you can use the ${ctx.link(dataflowgraph_builder_1.DataflowGraphBuilder)}.
-If you are interested in which features we support and which features are still to be worked on, please refer to our [capabilities](${doc_files_1.FlowrWikiBaseRef}/Capabilities) page.
+If you are interested in which features we support and which features are still to be worked on, please refer to our ${ctx.linkPage('wiki/Capabilities')} page.
 In summary, we discuss the following topics:
 
 - [Vertices](#vertices)
@@ -758,12 +758,12 @@ wiki page if you are unsure.
 
 > [!TIP]
 > If you want to investigate the dataflow graph,
-> you can either use the [Visual Studio Code extension](${doc_files_1.FlowrGithubBaseRef}/vscode-flowr) or the ${(0, doc_cli_option_1.getReplCommand)('dataflow*')}
-> command in the REPL (see the [Interface wiki page](${doc_files_1.FlowrWikiBaseRef}/Interface) for more information). 
-> There is also a simplified perspective available with ${(0, doc_cli_option_1.getReplCommand)('dataflowsimple*')} that does not show everything but is easier to read.
+> you can either use the [Visual Studio Code extension](${doc_files_1.FlowrVsCode}) or the ${ctx.replCmd('dataflow*')}
+> command in the REPL (see the ${ctx.linkPage('wiki/Interface', 'Interface wiki page')} for more information). 
+> There is also a simplified perspective available with ${ctx.replCmd('dataflowsimple*')} that does not show everything but is easier to read.
 > When using _flowR_ as a library, you may use the functions in ${(0, doc_files_1.getFilePathMd)('../util/mermaid/dfg.ts')}.
 > 
-> If you receive a dataflow graph in its serialized form (e.g., by talking to a [_flowR_ server](${doc_files_1.FlowrWikiBaseRef}/Interface)), you can use ${ctx.link(`${graph_1.DataflowGraph.name}::${graph_1.DataflowGraph.fromJson.name}`, { realNameWrapper: 'i', codeFont: true })} to retrieve the graph from the JSON representation.
+> If you receive a dataflow graph in its serialized form (e.g., by talking to a [_flowR_ server](${doc_files_1.FlowrWikiBaseRef}/Interface)), you can use ${ctx.linkM(graph_1.DataflowGraph, 'fromJson', { realNameWrapper: 'i', codeFont: true })} to retrieve the graph from the JSON representation.
 >
 > Also, check out the [${doc_files_1.FlowrGithubGroupName}/sample-analyzer-df-diff](${doc_files_1.FlowrGithubBaseRef}/sample-analyzer-df-diff) repository for a complete example project creating and comparing dataflow graphs.
 
@@ -773,7 +773,7 @@ ${await (0, doc_dfg_1.printDfGraphForCode)(treeSitter, 'x <- 3\ny <- x + 1\ny')}
 The above dataflow graph showcases the general gist. We define a dataflow graph as a directed graph G = (V, E), differentiating between ${(0, doc_data_dfg_util_1.getAllVertices)().length} types of vertices V and
 ${(0, doc_data_dfg_util_1.getAllEdges)().length} types of edges E allowing each vertex to have a single, and each edge to have multiple distinct types.
 Additionally, every node may have links to its [control dependencies](#control-dependencies) (which you may view as a ${(0, text_1.nth)((0, doc_data_dfg_util_1.getAllEdges)().length + 1)} edge type, 
-although they are explicitly no data dependency and relate to the [Control Flow Graph](${doc_files_1.FlowrWikiBaseRef}/Control%20Flow%20Graph)).
+although they are explicitly no data dependency and relate to the ${ctx.linkPage('wiki/Control Flow Graph')}. 
 
 <details open>
 

package/documentation/wiki-engine.d.ts

@@ -3,7 +3,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Engines
  */
-export declare class WikiEngine extends DocMaker {
+export declare class WikiEngine extends DocMaker<'wiki/Engines.md'> {
     constructor();
     text({ ctx }: DocMakerArgs): string;
 }

package/documentation/wiki-engine.js

@@ -5,7 +5,6 @@ const shell_1 = require("../r-bridge/shell");
 const shell_executor_1 = require("../r-bridge/shell-executor");
 const tree_sitter_executor_1 = require("../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor");
 const doc_files_1 = require("./doc-util/doc-files");
-const doc_cli_option_1 = require("./doc-util/doc-cli-option");
 const doc_structure_1 = require("./doc-util/doc-structure");
 const doc_maker_1 = require("./wiki-mk/doc-maker");
 /**
@@ -30,13 +29,13 @@ we provide the concept of engines.
 Engines can be loaded with [flowR's configuration file](${doc_files_1.FlowrWikiBaseRef}/Interface#configuring-flowr). Additionally, they
 are exposed with some command line options (e.g., when using the docker image of flowR):
 
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.r-shell.disabled', false)} to disable the ${ctx.link(shell_1.RShell)} engine
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.r-shell.r-path', false)} (which is the canonical version of ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'r-path')})
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.tree-sitter.disabled', false)} to disable the ${ctx.link(tree_sitter_executor_1.TreeSitterExecutor)} engine
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.tree-sitter.lax', false)} to use lax parsing with tree-sitter
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.tree-sitter.wasm-path', false)} pass the path to the wasm of the r grammar of tree-sitter (see [below](#tree-sitter))
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.tree-sitter.tree-sitter-wasm-path', false)} pass the path to the wasm of tree-sitter (see [below](#tree-sitter))
-- ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'default-engine', false)} to set the default engine to use
+- ${ctx.cliOption('flowr', 'engine.r-shell.disabled', false)} to disable the ${ctx.link(shell_1.RShell)} engine
+- ${ctx.cliOption('flowr', 'engine.r-shell.r-path', false)} (which is the canonical version of ${ctx.cliOption('flowr', 'r-path')})
+- ${ctx.cliOption('flowr', 'engine.tree-sitter.disabled', false)} to disable the ${ctx.link(tree_sitter_executor_1.TreeSitterExecutor)} engine
+- ${ctx.cliOption('flowr', 'engine.tree-sitter.lax', false)} to use lax parsing with tree-sitter
+- ${ctx.cliOption('flowr', 'engine.tree-sitter.wasm-path', false)} pass the path to the wasm of the r grammar of tree-sitter (see [below](#tree-sitter))
+- ${ctx.cliOption('flowr', 'engine.tree-sitter.tree-sitter-wasm-path', false)} pass the path to the wasm of tree-sitter (see [below](#tree-sitter))
+- ${ctx.cliOption('flowr', 'default-engine', false)} to set the default engine to use
 
 <a id="tree-sitter"></a>
 ## Dealing with the Tree-Sitter Engine
@@ -47,8 +46,8 @@ ${(0, doc_structure_1.block)({
         })}
 
 In general, there is no need for you to pass custom paths using either
-${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.tree-sitter.wasm-path', false)} or
-${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'engine.tree-sitter.tree-sitter-wasm-path', false)}.
+${ctx.cliOption('flowr', 'engine.tree-sitter.wasm-path', false)} or
+${ctx.cliOption('flowr', 'engine.tree-sitter.tree-sitter-wasm-path', false)}.
 However, you may want to experiment with the R grammar or provide a newer
 one in case that of _flowR_ is outdated.
 

package/documentation/wiki-faq.d.ts

@@ -2,7 +2,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/FAQ
  */
-export declare class WikiFaq extends DocMaker {
+export declare class WikiFaq extends DocMaker<'wiki/FAQ.md'> {
     constructor();
     text(): string;
 }

package/documentation/wiki-interface.d.ts

@@ -3,7 +3,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Interface
  */
-export declare class WikiInterface extends DocMaker {
+export declare class WikiInterface extends DocMaker<'wiki/Interface.md'> {
     constructor();
     protected text({ shell, ctx, treeSitter }: DocMakerArgs): Promise<string>;
 }

package/documentation/wiki-interface.js

@@ -94,11 +94,11 @@ with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
 
 `;
 }
-async function explainRepl(parser) {
+async function explainRepl(parser, ctx) {
     return `
 > [!NOTE]
-> To execute arbitrary R commands with a repl request, _flowR_ has to be started explicitly with ${(0, doc_cli_option_1.getCliLongOptionOf)('flowr', 'r-session-access')}.
-> Please be aware that this introduces a security risk and note that this relies on the [\`r-shell\` engine](${doc_files_1.FlowrWikiBaseRef}/Engines).
+> To execute arbitrary R commands with a repl request, _flowR_ has to be started explicitly with ${ctx.cliOption('flowr', 'r-session-access')}.
+> Please be aware that this introduces a security risk and note that this relies on the ${ctx.linkPage('wiki/Engines', '`r-shell` engine')} .
 
 Although primarily meant for users to explore, 
 there is nothing which forbids simply calling _flowR_ as a subprocess to use standard-in, -output, and -error 
@@ -108,8 +108,8 @@ with the [REPL Request](#message-request-repl-execution) message).
 The read-eval-print loop (REPL) works relatively simple.
 You can submit an expression (using <kbd>Enter</kbd>),
 which is interpreted as an R&nbsp;expression by default but interpreted as a *command* if it starts with a colon (\`:\`).
-The best command to get started with the REPL is ${(0, doc_cli_option_1.getReplCommand)('help')}.
-Besides, you can leave the REPL either with the command ${(0, doc_cli_option_1.getReplCommand)('quit')} or by pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> twice.
+The best command to get started with the REPL is ${ctx.replCmd('help')}.
+Besides, you can leave the REPL either with the command ${ctx.replCmd('quit')} or by pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> twice.
 When writing a *command*, you may press <kbd>Tab</kbd> to get a list of completions, if available.
 Multiple commands can be entered in a single line by separating them with a semicolon (\`;\`), e.g. \`:parse "x<-2"; :df*\`.
 If a command is given without R code, the REPL will re-use R code given in a previous command. 
@@ -142,20 +142,20 @@ the REPL will re-use previously obtained information and not re-parse the code a
 ### Example: Retrieving the Dataflow Graph
 
 To retrieve a URL to the [mermaid](https://mermaid.js.org/) diagram of the dataflow of a given expression, 
-use ${(0, doc_cli_option_1.getReplCommand)('dataflow*')} (or ${(0, doc_cli_option_1.getReplCommand)('dataflow')} to get the mermaid code in the cli):
+use ${ctx.replCmd('dataflow*')} (or ${ctx.replCmd('dataflow')} to get the mermaid code in the cli):
 
 ${await (0, doc_repl_1.documentReplSession)(parser, [{
             command: ':dataflow* y <- 1 + x',
             description: `Retrieve the dataflow graph of the expression \`y <- 1 + x\`. It looks like this:\n${await (0, doc_dfg_1.printDfGraphForCode)(parser, 'y <- 1 + x')}`
         }])}
 
-For the slicing with ${(0, doc_cli_option_1.getReplCommand)('slicer')}, you have access to the same [magic comments](#slice-magic-comments) as with the [slice request](#message-request-slice).
+For the slicing with ${ctx.replCmd('slicer')}, you have access to the same [magic comments](#slice-magic-comments) as with the [slice request](#message-request-slice).
 
 ### Example: Interfacing with the File System
 
-Many commands that allow for an R-expression (like ${(0, doc_cli_option_1.getReplCommand)('dataflow*')}) allow for a file as well 
+Many commands that allow for an R-expression (like ${ctx.replCmd('dataflow*')}) allow for a file as well 
 if the argument starts with \`${retriever_1.fileProtocol}\`. 
-If you are working from the root directory of the _flowR_ repository, the following gives you the parsed AST of the example file using the ${(0, doc_cli_option_1.getReplCommand)('parse')} command:
+If you are working from the root directory of the _flowR_ repository, the following gives you the parsed AST of the example file using the ${ctx.replCmd('parse')} command:
 
 ${await (0, doc_repl_1.documentReplSession)(parser, [{
             command: `:parse ${retriever_1.fileProtocol}test/testfiles/example.R`,
@@ -232,9 +232,9 @@ ${(0, doc_code_1.codeBlock)('json', JSON.stringify({
             }
         },
         abstractInterpretation: {
+            wideningThreshold: 4,
             dataFrame: {
                 maxColNames: 20,
-                wideningThreshold: 4,
                 readLoadedData: {
                     readExternalFiles: true,
                     maxReadLines: 1_000_000
@@ -436,8 +436,7 @@ class WikiInterface extends doc_maker_1.DocMaker {
     }
     async text({ shell, ctx, treeSitter }) {
         return `
-Although far from being as detailed as the in-depth explanation of
-[_flowR_](${doc_files_1.FlowrWikiBaseRef}/Core),
+Although far from being as detailed as the in-depth explanation of ${ctx.linkPage('wiki/Core', '_flowR_')},
 this wiki page explains how to interface with _flowR_ in more detail.
 In general, command line arguments and other options provide short descriptions on hover over.
 
@@ -454,7 +453,7 @@ ${await explainServer(shell)}
 <a id='using-the-repl'></a>
 ## 💻 Using the REPL
 
-${await explainRepl(treeSitter)}
+${await explainRepl(treeSitter, ctx)}
 
 <a id='configuring-flowr'></a>
 ## ⚙️ Configuring FlowR

package/documentation/wiki-linter.d.ts

@@ -3,7 +3,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Linter
  */
-export declare class WikiLinter extends DocMaker {
+export declare class WikiLinter extends DocMaker<'wiki/Linter.md'> {
     constructor();
     protected text({ treeSitter }: DocMakerArgs): Promise<string>;
 }

package/documentation/wiki-linting-and-testing.d.ts

@@ -3,7 +3,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Linting-and-Testing
  */
-export declare class WikiLintingAndTesting extends DocMaker {
+export declare class WikiLintingAndTesting extends DocMaker<'wiki/Linting and Testing.md'> {
     constructor();
     protected text({ ctx }: DocMakerArgs): string;
 }

package/documentation/wiki-mk/doc-context.d.ts

@@ -1,5 +1,10 @@
 import type { FnElementInfo, PrintHierarchyArguments, TypeElementKind } from '../doc-util/doc-types';
 import type { RShell } from '../../r-bridge/shell';
+import type { ValidWikiDocumentTargetsNoSuffix } from '../../cli/wiki';
+import type { PathLike } from 'fs';
+import type { scripts } from '../../cli/common/scripts-info';
+import type { ScriptOptions } from '../doc-util/doc-cli-option';
+import type { ReplCommandNames } from '../../cli/repl/commands/repl-commands';
 /**
  * Context available when generating documentation for a wiki in markdown format
  */
@@ -38,6 +43,9 @@ type NamedPrototype = {
 type ProtoKeys<T> = T extends {
     prototype: infer P;
 } ? keyof P : never;
+type StaticKeys<T> = T extends {
+    prototype: infer P;
+} ? Exclude<keyof T, keyof P> : never;
 /**
  * Provides methods to generate links, code snippets, and documentation for code elements.
  * These wrap around a collection of useful helpers originating from the doc utils.
@@ -78,7 +86,7 @@ export interface GeneralDocContext {
      * Creates a (markdown) link to the `myMethod` member of the `MyClass` class in the code base.
      * @see {@link GeneralWikiContext#link|link} - for the underlying impl.
      */
-    linkM<T extends NamedPrototype>(cls: T, element: ProtoKeys<T>, fmt?: LinkFormat & {
+    linkM<T extends NamedPrototype>(cls: T, element: ProtoKeys<T> | StaticKeys<T>, fmt?: LinkFormat & {
         hideClass?: boolean;
     }, filter?: ElementFilter): string;
     /**
@@ -169,6 +177,51 @@ export interface GeneralDocContext {
      * @param inlineTypes - Optional list of type names to inline in the mermaid diagram (instead of linking them out).
      */
     mermaid(element: ElementIdOrRef, inlineTypes?: string[]): string;
+    /**
+     * Generates a wiki link to another wiki or general docs page.
+     * @example
+     * ```ts
+     * linkWikiPage('wiki/Setup')
+     * ```
+     * Creates a link to the `wiki/Setup` wiki page with the link text `Setup`.
+     * @param pageName - The name of the wiki page to link to.
+     * @param linkText - Optional text to display for the link. If not provided, the page name will be used.
+     */
+    linkPage(pageName: ValidWikiDocumentTargetsNoSuffix, linkText?: string): string;
+    /**
+     * Generates a link to a code file in the code base.
+     * @param path       - The path to the code file.
+     * @param lineNumber - An optional line number to link to within the file.
+     */
+    linkCode(path: PathLike, lineNumber?: number): string;
+    /**
+     * Generates the CLI long option for a given script and option name.
+     * @example
+     * ```ts
+     * cliOption('flowr', 'help')
+     * ```
+     * Returns `--help` with the accompanying docs.
+     * @param scriptName - The name of the script (e.g., 'flowr', 'analyze', etc.)
+     * @param optionName - The name of the option for which to generate the long option string.
+     * @param withAlias  - Whether to include the alias in the output. Default is `false`.
+     * @param quote      - Whether to wrap the option in backticks. Default is `true`.
+     * @see {@link ScriptOptions} - for the valid option names per script.
+     * @see {@link getCliLongOptionOf} - for the underlying impl.
+     */
+    cliOption<ScriptName extends keyof typeof scripts | 'flowr', OptionName extends ScriptOptions<ScriptName>>(scriptName: ScriptName, optionName: OptionName, withAlias?: boolean, quote?: boolean): string;
+    /**
+     * Generates the REPL command string for a given command name.
+     * @example
+     * ```ts
+     * replCmd('help')
+     * ```
+     * Returns `:help` with the accompanying docs.
+     * @param commandName - The name of the REPL command.
+     * @param quote - Whether to wrap the command in backticks. Default is `true`.
+     * @param showStar - Whether to show a `[*]` suffix for starred commands. Default is `false`.
+     * @see {@link getReplCommand} - for the underlying impl.
+     */
+    replCmd(commandName: ReplCommandNames, quote?: boolean, showStar?: boolean): string;
 }
 /**
  * Creates a wiki context for generating documentation for code elements.

package/documentation/wiki-mk/doc-context.js

@@ -8,6 +8,8 @@ const doc_types_1 = require("../doc-util/doc-types");
 const path_1 = __importDefault(require("path"));
 const assert_1 = require("../../util/assert");
 const doc_auto_gen_1 = require("../doc-util/doc-auto-gen");
+const doc_files_1 = require("../doc-util/doc-files");
+const doc_cli_option_1 = require("../doc-util/doc-cli-option");
 function getNameFromElementIdOrRef(element) {
     if (typeof element === 'function') {
         return element.name;
@@ -78,6 +80,21 @@ function makeDocContextForTypes(shell, ...rootFolders) {
                 typeNameForMermaid: getNameFromElementIdOrRef(element),
                 inlineTypes
             });
+        },
+        linkPage(pageName, linkText) {
+            const text = linkText ?? pageName.split('/').pop() ?? pageName;
+            const link = pageName.toLowerCase().replace(/ /g, '-');
+            return `[${text}](${doc_files_1.FlowrGithubRef}/${link})`;
+        },
+        linkCode(path, lineNumber) {
+            const lnk = lineNumber ? `${path.toString()}#L${lineNumber}` : path.toString();
+            return `[${path.toString()}](${encodeURIComponent(lnk)})`;
+        },
+        cliOption(scriptName, optionName, withAlias = false, quote = true) {
+            return (0, doc_cli_option_1.getCliLongOptionOf)(scriptName, optionName, withAlias, quote);
+        },
+        replCmd(commandName, quote = true, showStar = false) {
+            return (0, doc_cli_option_1.getReplCommand)(commandName, quote, showStar);
         }
     };
 }

package/documentation/wiki-mk/doc-maker.d.ts

@@ -28,9 +28,9 @@ export declare enum WikiChangeType {
     UnimportantChange = 1,
     Identical = 2
 }
-export interface DocMakerLike {
+export interface DocMakerLike<Target extends string = string> {
     make(args: DocMakerArgs & DocMakerOutputArgs): Promise<boolean>;
-    getTarget(): string;
+    getTarget(): Target;
     getProducer(): string;
     getWrittenSubfiles(): Set<string>;
 }
@@ -42,7 +42,7 @@ export interface DocMakerLike {
  * If this wiki page produces multiple pages ("sub files"), you can use `writeSubFile` inside the `text` method
  * to write those additional files.
  */
-export declare abstract class DocMaker implements DocMakerLike {
+export declare abstract class DocMaker<Target extends string> implements DocMakerLike<Target> {
     private readonly target;
     private readonly filename;
     private readonly purpose;
@@ -57,11 +57,11 @@ export declare abstract class DocMaker implements DocMakerLike {
      * @param printHeader - Whether to print the auto-generation header. Default is `true`. Only mark this `false` if you plan to add it yourself.
      * @protected
      */
-    protected constructor(target: PathLike, filename: string, purpose: string, printHeader?: boolean);
+    protected constructor(target: Target, filename: string, purpose: string, printHeader?: boolean);
     /**
      * Gets the target path where the wiki file will be generated.
      */
-    getTarget(): string;
+    getTarget(): Target;
     /**
      * Gets the name of the producer of this wiki file.
      */

package/documentation/wiki-mk/doc-maker.js

@@ -17,6 +17,8 @@ const DefaultReplacementPatterns = [
     [/"[rR]": "\d+\.\d+\.\d+.*?"/g, ''],
     [/R\s*\d+\.\d+\.\d+/g, ''],
     [/v\d+\.\d+\.\d+/g, ''],
+    // clean paths
+    [/%2Fhome%2F([a-zA-Z0-9._-]+%2F)*/g, ''],
     // async wrapper depends on whether the promise got forfilled already
     [/async|%20/g, '']
 ];
@@ -53,7 +55,7 @@ class DocMaker {
      * Gets the target path where the wiki file will be generated.
      */
     getTarget() {
-        return this.target.toString();
+        return this.target;
     }
     /**
      * Gets the name of the producer of this wiki file.

package/documentation/wiki-normalized-ast.d.ts

@@ -3,7 +3,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Normalized-AST
  */
-export declare class WikiNormalizedAst extends DocMaker {
+export declare class WikiNormalizedAst extends DocMaker<'wiki/Normalized AST.md'> {
     constructor();
     protected text({ ctx, treeSitter }: DocMakerArgs): Promise<string>;
 }

package/documentation/wiki-onboarding.d.ts

@@ -2,7 +2,7 @@ import { DocMaker } from './wiki-mk/doc-maker';
 /**
  * https://github.com/flowr-analysis/flowr/wiki/Onboarding
  */
-export declare class WikiOnboarding extends DocMaker {
+export declare class WikiOnboarding extends DocMaker<'wiki/Onboarding.md'> {
     constructor();
     text(): string;
 }

package/documentation/wiki-overview.d.ts

@@ -0,0 +1,9 @@
+import type { DocMakerArgs } from './wiki-mk/doc-maker';
+import { DocMaker } from './wiki-mk/doc-maker';
+/**
+ * https://github.com/flowr-analysis/flowr/wiki/Overview
+ */
+export declare class WikiOverview extends DocMaker<'wiki/Overview.md'> {
+    constructor();
+    text({ ctx }: DocMakerArgs): string;
+}