Skip to content

docs: add documentation for 5 low-priority undocumented SHAFT_ENGINE features#446

Merged
MohabMohie merged 4 commits into
masterfrom
copilot/handle-low-priority-items
Apr 8, 2026
Merged

docs: add documentation for 5 low-priority undocumented SHAFT_ENGINE features#446
MohabMohie merged 4 commits into
masterfrom
copilot/handle-low-priority-items

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 7, 2026

Five SHAFT_ENGINE APIs identified in the documentation gap analysis (issue #440) had no coverage on the docs site. This PR adds dedicated pages for all 🟢 low-priority items.

New pages

  • docs/Reporting/Custom_Report_Messages.mdwithCustomReportMessage() on validation chains + the SHAFT.Report programmatic API (log(), report(), attach())
  • docs/Keywords/CLI/Docker_Terminal.mdTerminalActions Docker constructor for executing commands inside running containers
  • docs/Keywords/CLI/SSH_Terminal.mdTerminalActions SSH constructor with key-based auth and FileActions remote file transfer
  • docs/Keywords/GUI/didYouKnow/Clipboard_Actions.mddriver.element().clipboardActions() with the ClipboardAction enum (COPY, CUT, PASTE, SELECT_ALL)
  • docs/Keywords/GUI/didYouKnow/Kubernetes_Selenium_Grid.md — Deploying Selenium Grid on Kubernetes with KEDA auto-scaling via Helm and pointing SHAFT at the cluster-internal service DNS

Sidebar changes

  • CLI category: Docker Terminal and SSH Terminal inserted after Terminal Actions
  • GUI › Did You Know category: Kubernetes Grid and Clipboard Actions appended
  • Reporting: promoted from a single doc link to a collapsible category containing the existing Reporting page + the new Custom Report Messages page

Representative snippet

// Custom validation message — appears verbatim in the Allure step name
driver.assertThat()
    .browser().url().contains("/dashboard")
    .withCustomReportMessage("URL must contain /dashboard after successful login")
    .perform();

// Clipboard cut-and-paste chain
driver.element()
    .clipboardActions(By.id("editField"), ClipboardAction.SELECT_ALL)
    .clipboardActions(By.id("editField"), ClipboardAction.CUT)
    .clipboardActions(By.id("newField"),  ClipboardAction.PASTE);

// K8s Grid — point SHAFT at the in-cluster service
SHAFT.Properties.platform.set()
    .executionAddress("selenium-grid-selenium-hub.default.svc.cluster.local:4444");

Copilot AI linked an issue Apr 7, 2026 that may be closed by this pull request
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 7, 2026

Deploy Preview for shaftengine ready!

Name Link
🔨 Latest commit 2874690
🔍 Latest deploy log https://app.netlify.com/projects/shaftengine/deploys/69d6219f90d4720008b9da85
😎 Deploy Preview https://deploy-preview-446--shaftengine.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86
Accessibility: 93
Best Practices: 92
SEO: 100
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI and others added 2 commits April 7, 2026 21:13
Copilot AI changed the title [WIP] Fix handling of low priority items docs: add documentation for 5 low-priority undocumented SHAFT_ENGINE features Apr 7, 2026
Copilot AI requested a review from MohabMohie April 7, 2026 21:16
Signed-off-by: Mohab Mohie <Mohab.MohieElDeen@outlook.com>
@MohabMohie MohabMohie marked this pull request as ready for review April 8, 2026 09:36
@MohabMohie MohabMohie merged commit e3db1ed into master Apr 8, 2026
7 of 9 checks passed
@MohabMohie MohabMohie deleted the copilot/handle-low-priority-items branch April 8, 2026 09:36
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.

Handle low priority items

2 participants