Skip to content

docs: Add FAQ section to README #26

docs: Add FAQ section to README

docs: Add FAQ section to README #26

Workflow file for this run

name: Documentation Validation
on:
push:
branches:
- "**"
pull_request:
branches:
- main
- master
workflow_dispatch:
jobs:
validate-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install markdown-link-check
run: npm install -g markdown-link-check
- name: Check links in markdown files
run: |
for file in README.md CONTRIBUTING.md tests/README.md docs/*.md; do
if [ -f "$file" ]; then
markdown-link-check "$file"
fi
done