Release preparation#98
Merged
Merged
Conversation
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-98.surge.sh/robotframework-RFCP-syllabus/ |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the Docusaurus-based RFCP syllabus site and PDF pipeline for the 1.1.0 release by adding a frozen versioned documentation snapshot, improving PDF generation/post-processing, and updating download links/dependencies.
Changes:
- Adds
version-1.1.0docs, sidebars, version metadata, and PDF download wiring. - Introduces PDF post-processing with title page, TOC, footers, and internal link rewriting.
- Updates current documentation labels/content and bumps selected npm/Python dependencies.
Reviewed changes
Copilot reviewed 60 out of 66 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
.gitignore |
Ignores generated syllabus/font artifacts. |
requirements.txt |
Adds PDF post-processing dependencies. |
tools/gen_pdf.robot |
Uses production build and new post-processing flow. |
tools/pdf_postprocess.py |
Adds PDF merge, TOC, footer, and link rewrite logic. |
website/package.json |
Adds sidebar patch/restore hooks around build. |
website/package-lock.json |
Updates transitive npm dependencies. |
website/scripts/patch-versioned-sidebars.js |
Adds version placeholder patching for versioned sidebars. |
website/versions.json |
Adds release version 1.1.0. |
website/sidebars.ts |
Adds PDF download sidebar link for current docs. |
website/src/pages/index.tsx |
Updates homepage PDF download link. |
website/src/css/custom.css |
Adds print styles for PDF capture. |
website/src/theme/DocSidebarItem/Link/index.tsx |
Adds custom sidebar link rendering for downloads. |
website/src/theme/DocSidebarItem/Link/styles.module.css |
Styles custom sidebar download links. |
website/docs/overview.md |
Renames introduction heading. |
website/docs/chapter-01/_category_.json |
Updates chapter sidebar metadata. |
website/docs/chapter-01/05_organization.md |
Minor wording update. |
website/docs/chapter-02/_category_.json |
Updates chapter sidebar metadata. |
website/docs/chapter-02/03_executing.md |
Clarifies execution artifact wording. |
website/docs/chapter-03/_category_.json |
Updates chapter sidebar metadata. |
website/docs/chapter-04/_category_.json |
Updates chapter sidebar metadata. |
website/docs/chapter-05/_category_.json |
Updates chapter sidebar metadata. |
website/docs/chapter-05/01_advanced_variables.md |
Aligns ${OUTPUT_DIR} wording. |
website/versioned_sidebars/version-1.0.1-sidebars.json |
Adds versioned PDF download link. |
website/versioned_sidebars/version-1.1.0-sidebars.json |
Adds new 1.1.0 sidebar. |
website/versioned_docs/version-1.0.1/example-exam/Example-exam.mdx |
Removes old versioned example exam page. |
website/versioned_docs/version-1.1.0/overview.md |
Adds 1.1.0 overview page. |
website/versioned_docs/version-1.1.0/learning_objectives.md |
Adds 1.1.0 learning objectives. |
website/versioned_docs/version-1.1.0/glossary/Glossary.mdx |
Adds versioned interactive glossary page. |
website/versioned_docs/version-1.1.0/glossary/_category_.json |
Adds glossary category metadata. |
website/versioned_docs/version-1.1.0/example-exam/Example-exam.mdx |
Adds versioned example exam page. |
website/versioned_docs/version-1.1.0/example-exam/_category_.json |
Adds example exam category metadata. |
website/versioned_docs/version-1.1.0/chapter-01/_category_.json |
Adds chapter 1 category metadata. |
website/versioned_docs/version-1.1.0/chapter-01/00_overview.md |
Adds chapter 1 overview. |
website/versioned_docs/version-1.1.0/chapter-01/01_purpose.md |
Adds chapter 1 purpose content. |
website/versioned_docs/version-1.1.0/chapter-01/02_architecture.md |
Adds chapter 1 architecture content. |
website/versioned_docs/version-1.1.0/chapter-01/03_syntax.md |
Adds chapter 1 syntax content. |
website/versioned_docs/version-1.1.0/chapter-01/04_styles.md |
Adds chapter 1 specification styles content. |
website/versioned_docs/version-1.1.0/chapter-01/05_organization.md |
Adds chapter 1 organization content. |
website/versioned_docs/version-1.1.0/chapter-02/_category_.json |
Adds chapter 2 category metadata. |
website/versioned_docs/version-1.1.0/chapter-02/00_overview.md |
Adds chapter 2 overview. |
website/versioned_docs/version-1.1.0/chapter-02/01_suitefile.md |
Adds suite file content. |
website/versioned_docs/version-1.1.0/chapter-02/02_suitefile_syntax.md |
Adds suite syntax content. |
website/versioned_docs/version-1.1.0/chapter-02/03_executing.md |
Adds execution content. |
website/versioned_docs/version-1.1.0/chapter-02/04_keyword_imports.md |
Adds keyword import content. |
website/versioned_docs/version-1.1.0/chapter-02/05_keyword_interface.md |
Adds keyword interface content. |
website/versioned_docs/version-1.1.0/chapter-02/06_writing_test.md |
Adds keyword calling content. |
website/versioned_docs/version-1.1.0/chapter-03/_category_.json |
Adds chapter 3 category metadata. |
website/versioned_docs/version-1.1.0/chapter-03/00_overview.md |
Adds chapter 3 overview. |
website/versioned_docs/version-1.1.0/chapter-03/01_resource_file.md |
Adds resource file content. |
website/versioned_docs/version-1.1.0/chapter-03/02_variables.md |
Adds variables content. |
website/versioned_docs/version-1.1.0/chapter-03/03_user_keyword.md |
Adds user keyword content. |
website/versioned_docs/version-1.1.0/chapter-03/04_datadriven.md |
Adds data-driven content. |
website/versioned_docs/version-1.1.0/chapter-03/05_advanced_importing.md |
Adds advanced importing content. |
website/versioned_docs/version-1.1.0/chapter-04/_category_.json |
Adds chapter 4 category metadata. |
website/versioned_docs/version-1.1.0/chapter-04/00_overview.md |
Adds chapter 4 overview. |
website/versioned_docs/version-1.1.0/chapter-04/01_setups.md |
Adds setups content. |
website/versioned_docs/version-1.1.0/chapter-04/02_teardowns.md |
Adds teardowns content. |
website/versioned_docs/version-1.1.0/chapter-04/03_init_files.md |
Adds initialization files content. |
website/versioned_docs/version-1.1.0/chapter-04/04_tags.md |
Adds tags content. |
website/versioned_docs/version-1.1.0/chapter-04/05_skip.md |
Adds skip status content. |
website/versioned_docs/version-1.1.0/chapter-05/_category_.json |
Adds chapter 5 category metadata. |
website/versioned_docs/version-1.1.0/chapter-05/00_overview.md |
Adds chapter 5 overview. |
website/versioned_docs/version-1.1.0/chapter-05/01_advanced_variables.md |
Adds advanced variables content. |
website/versioned_docs/version-1.1.0/chapter-05/02_control_structures.md |
Adds control structures content. |
Files not reviewed (1)
- website/package-lock.json: Language not supported
Comments suppressed due to low confidence (1)
website/versioned_docs/version-1.0.1/example-exam/Example-exam.mdx:1
- Removing this versioned page leaves the visible 1.0.1 docs without the
example-exam/Example-examdoc that the global navbar still references. Because the site builds withonBrokenLinks: 'throw', production builds that include version 1.0.1 will fail unless this page is restored or the version-specific navigation is changed.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: René <snooz@posteo.de>
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-98.surge.sh/robotframework-RFCP-syllabus/ |
GerwinLaagland
approved these changes
May 29, 2026
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-98.surge.sh/robotframework-RFCP-syllabus/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces major improvements to the syllabus PDF generation process, including the addition of a custom post-processing script for enhanced PDF output, and several documentation and dependency updates. The most significant changes are the new
pdf_postprocess.pytool, updates to the Robot Framework documentation structure and content, and dependency upgrades for security and compatibility.PDF Generation Enhancements:
pdf_postprocess.pyscript that merges individual PDFs, adds a title page, table of contents with clickable links, custom footers, and rewrites internal links for the syllabus PDF usingreportlabandpypdf. This script is now called from the Robot Framework automation (gen_pdf.robot).gen_pdf.robotto collect URLs for each PDF page, adjust margins, and call the new post-processing script, significantly improving the final PDF's structure and navigability. [1] [2] [3]Documentation Structure and Content Updates:
_category_.jsonfiles to provide more descriptive labels, set positions, and add overview links, improving navigation and clarity in the documentation. [1] [2] [3] [4] [5]Dependency Upgrades:
express,body-parser,qs) inpackage-lock.jsonto the latest versions, addressing potential security and compatibility issues. [1] [2] [3] [4] [5]Content Fixes*