Skip to content

ci(docs-linting):support complex documentation structures #50

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.

Sign up for GitHub

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

Open
edro15 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

ci(docs-linting):support complex documentation structures #50

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a57056
ci(docs-linting):added support to complex doc structures
edro15 Apr 23, 2026
a56a57e
ci(docs-deploy):copying docs instead of moving over
edro15 Apr 23, 2026
54e308c
ci(docs-deploy):restored mv docs instead of copying
edro15 Apr 23, 2026
442f371
style:removed commented line
edro15 Apr 23, 2026
cd926da
Merge branch 'main' into enhance-docs-linting
edro15 Jun 2, 2026
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
20 changes: 17 additions & 3 deletions .github/workflows/reusable-docs-linting.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,30 @@ jobs:
exit 1
fi
- name: Check whether docs exists and contains a README
id: check-readme
run: |
if [ -d "./docs" ]; then
echo "Folder exists."
if [ ! -f "./docs/readme.md" ]; then
echo "❌ docs/readme.md file is missing"
exit 1
# Check for other markdown files in docs and its subfolders
md_count=$(find ./docs -type f -name "*.md" | wc -l)
if [ "$md_count" -gt 0 ]; then
echo "✅ docs/readme.md is missing, but found $md_count markdown file(s) in docs/."
echo "has_simple_readme=false" >> $GITHUB_OUTPUT
else
echo "❌ docs/readme.md is missing and no other markdown files found in docs/."
exit 1
fi
else
echo "✅ docs/readme.md exists."
echo "has_simple_readme=true" >> $GITHUB_OUTPUT
fi
else
echo "❌ Folder 'docs' does not exist."
exit 1
fi
- name: Check for required sections in Documentation
if: steps.check-readme.outputs.has_simple_readme == 'true'
run: |
patterns=(
"#{1,3} Contributing"
Expand All @@ -53,12 +65,14 @@ jobs:
fi
done
- name: Check for empty sections
if: steps.check-readme.outputs.has_simple_readme == 'true'
run: |
if grep -Eq "^#+ .+\\n(?:\\n[#+|$]|[#+|$])" docs/readme.md; then
echo "Empty section found in docs/readme.md ❌ Please add content"
exit 1
fi
- name: Check for incomplete sections
if: steps.check-readme.outputs.has_simple_readme == 'true'
run: |
if grep -Eq "TODO" docs/readme.md; then
echo "Found 'TODO' in one or more paragraphs in docs/readme.md ❌ Please add proper content"
Expand All @@ -76,7 +90,7 @@ jobs:
# Download and install packages
vale sync
# Execute
vale --output=JSON docs/*.md > vale-report.json || true
find ./docs -type f -name "*.md" -print0 | xargs -0 vale --output=JSON > vale-report.json || true

- name: Upload Results
uses: actions/upload-artifact@v7
Expand Down