Fix markdown links in docs and add docfx CI validation (#862)

* Initial plan

* Replace obsolete API references with xref tags in markdown docs

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* Add documentation guidelines for xref syntax

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* Fix: Only update link URLs, preserve document structure

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* Add --warningsAsErrors flag to docfx command in Makefile

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* Add CI validation for document generation

* Fix broken link

* Fix invalid xref cross-references in documentation

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* Apply suggestion from @eiriktsarpalis

* Fix Progress link syntax and remove docs/README.md

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* Separate build & test targets

* Apply suggestion from @eiriktsarpalis

* tweak Makefile

* Fix test results upload path

* Add emojis to CI workflow step names

Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>

* perform manual cleanups

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: eiriktsarpalis <2813363+eiriktsarpalis@users.noreply.github.com>
Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com>
This commit is contained in:
Copilot 2025-10-14 17:24:32 +03:00 • committed by GitHub
commit b40f06c043
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -34,12 +34,12 @@ jobs:
runs-on: ${{ matrix.os }}
steps:
- name: Clone the repo
- name: 📥 Clone the repo
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
- name: Set up .NET
- name: 🔧 Set up .NET
uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
with:
dotnet-version: |
@ -47,51 +47,44 @@ jobs:
9.0.x
# NetFX testing on non-Windows requires mono
- name: Setup Mono
- name: 🔧 Setup Mono
if: runner.os == 'Linux'
run: sudo apt-get install -y mono-devel
- name: Setup Mono on macOS
- name: 🔧 Setup Mono on macOS
if: runner.os == 'macOS'
run: brew install mono
- name: Set up Node.js
- name: 🔧 Set up Node.js
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
with:
node-version: '20'
- name: Install dependencies for tests
- name: 📦 Install dependencies for tests
run: npm install @modelcontextprotocol/server-everything
- name: Install dependencies for tests
- name: 📦 Install dependencies for tests
run: npm install @modelcontextprotocol/server-memory
- name: Build
run: dotnet build --configuration ${{ matrix.configuration }}
- name: 🏗️ Build
run: make build CONFIGURATION=${{ matrix.configuration }}
- name: Pack
run: dotnet pack --configuration ${{ matrix.configuration }}
- name: 🧪 Test
run: make test CONFIGURATION=${{ matrix.configuration }}
- name: Test
run: >-
dotnet test
--filter '(Execution!=Manual)'
--no-build
--configuration ${{ matrix.configuration }}
--logger "trx"
--logger "GitHubActions;summary.includePassedTests=true;summary.includeSkippedTests=true"
--blame
--blame-hang-timeout 7m
--blame-crash
--results-directory testresults
--collect "XPlat Code Coverage" -- RunConfiguration.CollectSourceInformation=true
- name: 📦 Pack
if: matrix.configuration == 'Release'
run: make pack CONFIGURATION=${{ matrix.configuration }}
- name: Upload test results artifact
- name: 📚 Generate docs
run: make generate-docs CONFIGURATION=${{ matrix.configuration }}
- name: 📤 Upload test results artifact
if: always()
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: testresults-${{ matrix.os }}-${{ matrix.configuration }}
path: testresults/**
path: artifacts/testresults/**
publish-coverage:
if: github.actor != 'dependabot[bot]'