Skip to content

feat: add documentation website#4

Merged
shantoislamdev merged 2 commits into
mainfrom
feature/add-docs-website
May 29, 2026
Merged

feat: add documentation website#4
shantoislamdev merged 2 commits into
mainfrom
feature/add-docs-website

Conversation

@shantoislamdev

@shantoislamdev shantoislamdev commented May 29, 2026

Copy link
Copy Markdown
Owner

Description

This PR adds a dedicated documentation website under the website/ directory at the project root. The documentation has been thoroughly corrected and updated to match the actual SDK implementation and configuration APIs. Additionally, developer/build dependencies have been refined to ensure seamless local builds on Windows environments.

Key Changes

  1. New Documentation Website Module: Added a modern Vite + React + TailwindCSS v4 documentation hub at /website.
  2. Corrected SDK Coordinates: Fixed Maven coordinates (com.shantoislamdev -> dev.shantoislam) in Home and Integration Guide pages.
  3. Comprehensive Configuration Guide: Expanded the configuration table to fully detail all 15 SDK configuration parameters (such as screenshotQuality, screenshotMaxDimension, pageSettleDebounceMs, etc.).
  4. Accurate Agent Action Reference:
    • Added SelectOption(agentId, value) and GetDropdownOptions(agentId) details.
    • Updated action signatures for PreviousPage and NextPage with optional agentId.
  5. Robust Error & State Diagnostics:
    • Added IDLE lifecycle state to page state transitions table.
    • Documented missing SDK error types: JsEvaluationTimeout, ScreenshotFailed, and PageNotReady.
  6. Windows Native Build Support: Added optional native package bindings (@rollup/rollup-win32-x64-msvc, lightningcss-win32-x64-msvc, and @tailwindcss/oxide-win32-x64-msvc) to package.json to fix compilation issues on Windows development environments.

Verification

Successfully ran Vite compilation:

cd website && npm run build
  • Result: Built successfully in 2.87s with no warnings or errors.

@shantoislamdev shantoislamdev merged commit d80a607 into main May 29, 2026
2 checks passed
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.

1 participant