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
Copy file name to clipboardExpand all lines: CONTRIBUTION.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,7 @@ Thanks for helping us improve the RFCP syllabus! The notes below explain how to
13
13
python bootstrap.py
14
14
```
15
15
The script upgrades `pip`, installs `pre-commit`, and asks whether you want to pull in the optional PDF toolchain (Robot Framework + Browser batteries from `requirements.txt`, plus Chromium via `rfbrowser install chromium`). Answer "y" only if you plan to regenerate the PDF. Regardless of that choice, the script installs the pre-commit hook and then runs `npm install` inside `website/` so Docusaurus has its dependencies.
16
-
2. Activate the freshly created virtual environment so local commands use the same interpreters as the hooks:
17
-
- macOS/Linux: `source .venv/bin/activate`
18
-
- Windows (PowerShell): `.venv\Scripts\Activate.ps1`
19
-
3. Start Docusaurus in development mode while you edit:
16
+
2. Start Docusaurus in development mode while you edit:
20
17
```bash
21
18
cd website # if not already there
22
19
npm run start
@@ -28,10 +25,16 @@ Thanks for helping us improve the RFCP syllabus! The notes below explain how to
28
25
- Docusaurus validates internal links during builds. Run `npm run build` before submitting a PR to catch broken anchors or missing pages early.
29
26
30
27
## 4. Generating the syllabus PDF
31
-
To rebuild the certification PDF from the Robot Framework assets, run the Robot Framework suite from the repo root:
32
-
```bash
33
-
robot -d results tools/gen_pdf.robot
34
-
```
28
+
To rebuild the syllabus PDF from the Robot Framework assets, run the Robot Framework suite from the repo root:
29
+
30
+
1. Activate the created virtual environment so local commands use the same interpreters as the hooks:
31
+
- macOS/Linux: `source .venv/bin/activate`
32
+
- Windows (PowerShell): `.venv\Scripts\Activate.ps1`
33
+
34
+
2. Run the suite to generate the PDF:
35
+
```bash
36
+
robot -d results tools/gen_pdf.robot
37
+
```
35
38
The PDF and execution logs land inside `results/`.
36
39
37
40
Following the steps above keeps your local environment consistent with CI and ensures contributions land cleanly. Happy writing!
0 commit comments