Skip to content

feat: create a new docs website #2525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Basic `dependabot.yml` file with
# minimum configuration for three package managers

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
groups:
docusaurus:
patterns:
- "@docusaurus/*"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
34 changes: 34 additions & 0 deletions .github/workflows/microsoft-build-website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Build Website

on:
workflow_call:
outputs:
build-path:
description: "Path to the build directory"
value: ${{ jobs.build.outputs.build-path }}

jobs:
build:
name: "Build the website"
runs-on: ubuntu-24.04
outputs:
build-path: ./build
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '22'
- name: Install dependencies
run: yarn
working-directory: ./docsite
- name: Build website
run: yarn build
working-directory: ./docsite
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: website-build
path: ./docsite/build
retention-days: 1
38 changes: 38 additions & 0 deletions .github/workflows/microsoft-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: PR

on:
pull_request:
types: [opened, synchronize, edited]
branches: [ "main" ]

concurrency:
# Ensure single build of a pull request. `main` should not be affected.
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
lint-commit:
name: "Lint PR title"
permissions: {}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
filter: blob:none
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: '22'
# We lint the PR title instead of the commit message to avoid script injection attacks.
# Using environment variables prevents potential security vulnerabilities as described in:
# https://docs.github.com/en/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#example-of-a-script-injection-attack
- name: Lint PR title
env:
PR_TITLE: ${{ github.event.pull_request.title }}
run: |
echo "$PR_TITLE" | npx @rnx-kit/[email protected]
build-website:
name: "Build the website"
permissions: {}
uses: ./.github/workflows/microsoft-build-website.yml

54 changes: 54 additions & 0 deletions .github/workflows/microsoft-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Deploy to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued. However, do NOT cancel in-progress runs as we
# want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
uses: ./.github/workflows/microsoft-build-website.yml

# Prepare for Pages deployment
prepare-pages:
runs-on: ubuntu-24.04
needs: build
steps:
- name: Download build artifacts
uses: actions/download-artifact@v4
with:
name: website-build
path: ./docsite/build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docsite/build

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-24.04
needs: prepare-pages
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
16 changes: 0 additions & 16 deletions docs/WritingNativeComponents.md

This file was deleted.

Loading
Loading