From c093ccce3376a08d2b44742557963302b1a4d6a3 Mon Sep 17 00:00:00 2001 From: Peterson Fernandes Date: Mon, 2 Nov 2026 12:53:56 -0300 Subject: [PATCH] fix(docs): render the site home page again GitHub Pages used to run the legacy builder, whose jekyll-readme-index plugin turned docs/README.md into /index.html. pages.yml now runs plain Jekyll, so the root deployed without an index.html and every visit returned 404 (the API reference at /api/ was fine). Add docs/index.md that includes README.md under the default layout, and make both docs jobs assert that _site/index.html (and the API index) exist so a missing entry point can never deploy again. --- .github/workflows/ci.yml | 5 +++++ .github/workflows/pages.yml | 8 ++++++++ docs/index.md | 5 +++++ 3 files changed, 18 insertions(+) create mode 100644 docs/index.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ae79ff5..242f60a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -232,6 +232,11 @@ jobs: gem install jekyll -v 4.3.4 --no-document jekyll build --source docs --destination _site --strict_front_matter --trace + - name: Verify the site entry point exists + run: | + test -f _site/index.html + test -f _site/getting-started.html + - name: Build DocFX API reference shell: pwsh run: ./scripts/build-api-docs.ps1 diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index c3edeb6..af33509 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -61,10 +61,18 @@ jobs: gem install jekyll -v 4.3.4 --no-document jekyll build --source docs --destination _site --strict_front_matter --trace + - name: Verify the site entry point exists + run: | + test -f _site/index.html + test -f _site/getting-started.html + - name: Build DocFX API reference shell: pwsh run: ./scripts/build-api-docs.ps1 + - name: Verify the API reference exists + run: test -f _site/api/index.html + - name: Upload Pages artifact uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 with: diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..995a7ff --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +--- +layout: default +--- + +{% include_relative README.md %}