Skip to content

Commit 7ffe4c1

Browse files
docs: Add comprehensive VitePress documentation (#14)
* docs: Add comprehensive VitePress documentation Create complete documentation site for rhdh-e2e-test-utils using VitePress: - Guide section: installation, quick-start, core concepts, deployment, helpers, page objects, utilities, and configuration - API reference: detailed method signatures and types for all exports - Tutorials: step-by-step guides for common use cases - Examples: copy-paste ready code examples Additional features: - GitHub Actions workflow for automatic deployment to GitHub Pages - Standalone docs package with its own package.json and yarn.lock - Reusable snippets to reduce duplication - CLAUDE.md guide for documentation maintenance Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix CI yarn install * fix CI yarn check --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 2cca605 commit 7ffe4c1

File tree

93 files changed

+14490
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+14490
-4
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/deploy-docs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: pages
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
defaults:
25+
run:
26+
working-directory: docs
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v4
30+
with:
31+
fetch-depth: 0
32+
33+
- name: Setup Node.js
34+
uses: actions/setup-node@v4
35+
with:
36+
node-version: 22
37+
38+
- name: Setup Pages
39+
uses: actions/configure-pages@v5
40+
41+
- name: Install dependencies
42+
run: yarn install
43+
44+
- name: Build documentation
45+
run: yarn build
46+
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v3
49+
with:
50+
path: docs/.vitepress/dist
51+
52+
deploy:
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
needs: build
57+
runs-on: ubuntu-latest
58+
steps:
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ build/
5353
*.tsbuildinfo
5454
dist/
5555

56+
# VitePress
57+
docs/.vitepress/cache/
58+
docs/.vitepress/dist/
59+
5660
# Coverage
5761
coverage/
5862
.nyc_output/

0 commit comments

Comments
 (0)