diff --git a/.github/workflows/validate-docs.yml b/.github/workflows/validate-docs.yml new file mode 100644 index 0000000..beb1130 --- /dev/null +++ b/.github/workflows/validate-docs.yml @@ -0,0 +1,47 @@ +name: Validate Documentation + +on: + pull_request: + paths: + - 'src/**' + - 'website/**' + - 'package*.json' + - '.nvmrc' + +jobs: + validate-docs: + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version-file: .nvmrc + + - name: Install SDK dependencies + run: npm ci + + - name: Install docusaurus dependencies + working-directory: ./website + run: npm ci + + - name: Build documentation + working-directory: ./website + run: npm run build + + - name: Validate documentation build + run: | + if [ ! -d "website/build" ]; then + echo "❌ Documentation build failed - no build directory found" + exit 1 + fi + + if [ ! -f "website/build/index.html" ]; then + echo "❌ Documentation build failed - no index.html found" + exit 1 + fi + + echo "✅ Documentation build successful" diff --git a/CHANGELOG.md b/CHANGELOG.md index ba3da56..ab6d74a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,26 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [6.1.0](https://github.com/Doist/todoist-api-typescript/compare/v6.0.1...v6.1.0) (2025-11-08) - ### Features -* add custom HTTP client support for cross-platform compatibility ([#383](https://github.com/Doist/todoist-api-typescript/issues/383)) ([e5f13e5](https://github.com/Doist/todoist-api-typescript/commit/e5f13e5de3686e6ba7469b199ab05886086b68d6)) - +- add custom HTTP client support for cross-platform compatibility ([#383](https://github.com/Doist/todoist-api-typescript/issues/383)) ([e5f13e5](https://github.com/Doist/todoist-api-typescript/commit/e5f13e5de3686e6ba7469b199ab05886086b68d6)) ### Bug Fixes -* configure Release Please to not include component in tags ([ac0cc9d](https://github.com/Doist/todoist-api-typescript/commit/ac0cc9d4c6d2b84d89c095773f928b9ab7b28fa1)) -* rename release-please config file to correct filename ([73c9e5c](https://github.com/Doist/todoist-api-typescript/commit/73c9e5cb4bbe6cf02a73f5859bb043d1d2cda373)) - +- configure Release Please to not include component in tags ([ac0cc9d](https://github.com/Doist/todoist-api-typescript/commit/ac0cc9d4c6d2b84d89c095773f928b9ab7b28fa1)) +- rename release-please config file to correct filename ([73c9e5c](https://github.com/Doist/todoist-api-typescript/commit/73c9e5cb4bbe6cf02a73f5859bb043d1d2cda373)) ### Code Refactoring -* migrate all tests from mockFetch to MSW ([#384](https://github.com/Doist/todoist-api-typescript/issues/384)) ([1d5c150](https://github.com/Doist/todoist-api-typescript/commit/1d5c150b0336ac9eab95916bab2489274178519c)) - +- migrate all tests from mockFetch to MSW ([#384](https://github.com/Doist/todoist-api-typescript/issues/384)) ([1d5c150](https://github.com/Doist/todoist-api-typescript/commit/1d5c150b0336ac9eab95916bab2489274178519c)) ### Miscellaneous -* set up Release Please for automated releases ([#385](https://github.com/Doist/todoist-api-typescript/issues/385)) ([4402acc](https://github.com/Doist/todoist-api-typescript/commit/4402acc5325a5c9a59ea47c40853f2b143cb30ff)) +- set up Release Please for automated releases ([#385](https://github.com/Doist/todoist-api-typescript/issues/385)) ([4402acc](https://github.com/Doist/todoist-api-typescript/commit/4402acc5325a5c9a59ea47c40853f2b143cb30ff)) ## [Unreleased] diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index e5d26ba..969e52f 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -111,6 +111,7 @@ const config: Config = { readme: 'none', tsconfig: '../tsconfig.json', useCodeBlocks: true, + sanitizeComments: true, sidebar: { autoConfiguration: true }, disableSources: true, expandObjects: true,