You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
update Docusaurus and fixed vulnerabilities. (#89)
Updates the Docusaurus website dependencies and configuration to target Docusaurus 3.10 while improving compatibility with upcoming v4 changes, plus cleans up generated quiz artifacts and MDX syntax in docs.
**Changes:**
- Bump Docusaurus packages to `^3.10.0`, add `@docusaurus/faster`, raise Node engine requirement to `>=20`, and add security-related `overrides`.
- Enable Docusaurus `future.v4` flag and remove large blocks of commented-out navbar/footer configuration.
- Replace HTML comments in docs with MDX-compatible `{/* ... */}` comments and remove generated timestamps from quiz-generated files.
Copy file name to clipboardExpand all lines: website/docs/chapter-02/01_suitefile.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -194,7 +194,7 @@ A suite file must contain either a `*** Test Cases ***` or a `*** Tasks ***` sec
194
194
195
195
See [2.6 Writing Test|Task and Calling Keywords](chapter-02/06_writing_test.md) for more information about the `*** Test Cases ***` or `*** Tasks ***` section.
196
196
197
-
<!-- TODO maybe more references to Test Setup/Teardown or Documentation? -->
197
+
{/* TODO maybe more references to Test Setup/Teardown or Documentation? */}
198
198
199
199
### 2.1.2.4 Introduction to `*** Keywords ***` Section
Copy file name to clipboardExpand all lines: website/docs/chapter-02/02_suitefile_syntax.md
+1-4Lines changed: 1 addition & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,8 @@
1
1
2
2
# 2.2 Basic Suite File Syntax
3
3
4
-
<!--
5
-
TODO:
6
-
I think this section needs a bit more structure and we should introduce the concept of "settings" like [Documentation] already here and reference to Chapter 4.
4
+
{/* TODO: I think this section needs a bit more structure and we should introduce the concept of "settings" like [Documentation] already here and reference to Chapter 4.*/}
Copy file name to clipboardExpand all lines: website/docs/chapter-02/04_keyword_imports.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,10 @@
1
1
2
2
# 2.4 Keyword Imports
3
3
4
-
<!-- To use Keywords that are not part of BuiltIn, which is always imported invisibly, you must import keywords into the current scope. Basically Two different sources of keywords.
4
+
{/* TODO: To use Keywords that are not part of BuiltIn, which is always imported invisibly, you must import keywords into the current scope. Basically Two different sources of keywords.
5
5
- Libraries, which contains low-level keywords actually implementing functionality, typically in Python.
6
-
- Resource Files, which either again import libraries or other Resource Files or they specify User Keywords. -->
6
+
- Resource Files, which either again import libraries or other Resource Files or they specify User Keywords. */}
7
+
7
8
Robot Framework has a modular design that allows users to import keywords from external sources.
8
9
Without importing external keywords into a suite, only the keywords from Robot Framework's BuiltIn library are available for use, due to them being imported automatically.
9
10
Also the Robot Framework language statements themselves are available for use without importing them.
@@ -37,7 +38,7 @@ From a user perspective there are three different kinds of libraries:
37
38
-**Custom Libraries**: These libraries are developed by the users themselves to solve specific problems or to encapsulate more complex functionality.
38
39
39
40
Further more detailed information about the different types of libraries and are described in later chapters.
40
-
<!-- TODO: Do we fulfill this promise? -->
41
+
{/* TODO: Do we fulfill this promise? */}
41
42
42
43
To import a library into a suite or resource file the `Library` setting is used in the `*** Settings ***` section followed by the name of the library as long as they are located in the Python module search path, which automatically happens if they are installed via `pip`.
43
44
The name of the library is case-sensitive and should be taken from the library's keyword documentation.
Copy file name to clipboardExpand all lines: website/docs/chapter-02/05_keyword_interface.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Basically all standard and external 3rd party libraries offer these Keyword Docu
20
20
21
21
Robot Framework offers the Keyword Documentation of its Standard Libraries at https://robotframework.org/robotframework .
22
22
23
-
<!--Keywords from Libraries and Resources can be called and can be documented either as HTML or in IDEs with Robot Support. -->
23
+
{/* TODO: Keywords from Libraries and Resources can be called and can be documented either as HTML or in IDEs with Robot Support. */}
24
24
25
25
26
26
@@ -406,7 +406,7 @@ The error message would be: `ValueError: Argument 'y' got value 'Not_A_Number' t
406
406
407
407
The advantage of using type hints is that the user get more information about what kind of values are expected and the keyword implementation can be simpler, because it can rely on the arguments being of the expected type.
408
408
409
-
<!--Just to understand that they are there and that they may document how values are handled or which are allowed. -->
409
+
{/* TODO: Just to understand that they are there and that they may document how values are handled or which are allowed. */}
410
410
411
411
412
412
### 2.5.2.9 Return Types
@@ -430,7 +430,7 @@ Similar to the argument types, return types are optional and a more recent featu
430
430
It is important to know that keywords without a return type hint are often still returning values!
431
431
This is typically documented in the *Documentation* part of the keyword documentation.
432
432
433
-
<!--Keywords may gather information and return these to the caller of that keyword. A Documented Return Value may be present but often it is just written in the docs, due to new feature -->
433
+
{/* TODO: Keywords may gather information and return these to the caller of that keyword. A Documented Return Value may be present but often it is just written in the docs, due to new feature */}
0 commit comments