Skip to content

Update syllabus docs for RF 7.5 concepts - #100

Open
bennyvw wants to merge 11 commits into
mainfrom
copilot/analyse-release-notes-impact-syllabus
Open

bennyvw wants to merge 11 commits into
mainfrom
copilot/analyse-release-notes-impact-syllabus

Conversation

@bennyvw

@bennyvw bennyvw commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

To be reviewed and discussed in our upcoming committee meeting.
I doubt if 'Robot Framework 7.5' should be mentioned literally.

Co-authored-by: bennyvw <32094302+bennyvw@users.noreply.github.com>
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Some RF 7.5 guidance is inaccurate or inconsistent with the updated keyword interfaces.

Review effort: Balanced
Findings: 4 Medium severity

Open (4)
What changed in this PR

Updates the syllabus for Robot Framework 7.5 concepts.

Changes:

  • Introduces test/task metadata and distinguishes it from tags.
  • Documents Libdoc formatting enhancements.
  • Covers deprecated tag-filter syntax.
File Description
04_tags.md Clarifies tag purposes and deprecated filters.
05_keyword_interface.md Describes enhanced Libdoc output.
01_suitefile.md Adds test/task metadata guidance.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread website/docs/chapter-02/01_suitefile.md Resolved
Comment thread website/docs/chapter-04/04_tags.md Resolved
Comment thread website/docs/chapter-02/01_suitefile.md Resolved

Each test case or task is structured using an indentation-based format. The first un-indented line specifies the name of the test|task, followed by indented lines containing **keyword calls** and their possible **arguments** and test|task-specific settings.
These optional settings like `[Setup]`, `[Teardown]`, and `[Timeout]` can be applied to individual test cases or tasks to control their behavior or provide additional details.
These optional settings like `[Setup]`, `[Teardown]`, `[Timeout]`, `[Tags]`, and `[Metadata]` can be applied to individual test cases or tasks to control their behavior or provide additional details.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we exclude tags here on purpose? It seems correct to add it. Also, if we do add 'metadata' we may need to add 'Test Metadata' in the glossary as well.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion here is to trial a 'exhaustive list' like in the user guide can be found:
https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#test-case-section


![Should Be Equal Keyword Documentation](/img/Should_Be_Equal_Docs.png)

This keyword has 2 "Mandatory Arguments" and 6 "Optional Arguments".

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should adjust this picture again. Should be Equal has gotten 8 optional arguments now.

Image

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread website/docs/chapter-04/04_tags.md Resolved
@bennyvw

bennyvw commented Oct 15, 2026

Copy link
Copy Markdown
Contributor Author

Use new svg's and add glossary item Test Metadata.

Clarify documentation expectations for keywords and user keywords.
Copilot AI balanced review requested due to automatic review settings October 21, 2026 14:55
Removed a sentence about documentation output formats.
@github-actions

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Version-specific wording and syllabus scope still require the requested committee review.

3 open issues
1 resolved since last review

Review effort: Balanced

@github-actions

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The version-specific documentation and tag-deprecation notes remain despite explicit requests to remove them.

1 open issue
2 resolved since last review

Review effort: Balanced

Remove deprecated information about compact forms and Boolean operators.
@github-actions

Copy link
Copy Markdown

Co-authored-by: bennyvw <32094302+bennyvw@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The version-specific syllabus framing still needs the committee decision requested in the PR description.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 21, 2026 15:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Syllabus scope and explicit RF 7.5 wording remain pending committee decisions.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 21, 2026 16:24
@github-actions

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Duplicate glossary entries create repeated rows, duplicate identifiers, and inconsistent definition lookup.

1 open issue

Review effort: Balanced

Comment thread website/static/glossary/glossary.json Resolved
Removed 'Test Metadata' entry from glossary.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 21, 2026 16:30
@github-actions

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The explicit RF 7.5 sentence remains despite the developer’s request to remove it.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@github-actions

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Final approval requires the planned committee decision on syllabus scope and version-specific wording.

No open issues 🎉

Review effort: Balanced

@github-actions

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation changes are consistent, with no unresolved actionable findings.

No open issues 🎉

Review effort: Balanced

This branch was successfully deployed

1 active deployment
preview — 84d73e34 Deployed Oct 21, 2026 by bennyvw via Deploy Preview to Surge #201
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants