docs: add workflow to notify documentation site on changes#1001
Merged
Conversation
The Pages site is now hosted in Testably.Site, which fetches the documentation content from this repo over the GitHub API. The local build-and-deploy job is therefore obsolete; the cross-repo dispatch lives in the separate notify-docs-site workflow.
|
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR appears to migrate documentation-site responsibility out of this repository by removing the in-repo Docusaurus site and page deployment pipeline, and replacing it with a workflow that asks Testably/Testably.Site to rebuild when docs content changes here.
Changes:
- Remove the in-repo docs site, its build/deploy workflows, and the supporting NUKE target.
- Replace the old landing page content with a docs page entry under
Docs/pages/docs/index.mdx. - Add a GitHub Actions workflow that dispatches a rebuild event to
Testably/Testably.Siteon docs changes.
Reviewed changes
Copilot reviewed 17 out of 22 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| Testably.Abstractions.slnx | Removes the old Pages workflow from the solution manifest. |
| Pipeline/Build.Pages.cs | Deletes the NUKE target that fetched extension docs and prepared the docs site. |
| Docs/pages/tsconfig.json | Removes TypeScript config for the deleted Docusaurus site. |
| Docs/pages/static/CNAME | Removes custom-domain config tied to the deleted site. |
| Docs/pages/src/pages/index.tsx | Deletes the old custom home page implementation. |
| Docs/pages/src/pages/index.module.css | Deletes styles used by the removed home page. |
| Docs/pages/src/css/custom.css | Deletes global Docusaurus theme overrides. |
| Docs/pages/sidebars.ts | Removes sidebar config for the deleted site. |
| Docs/pages/package.json | Removes the Docusaurus app package manifest and scripts. |
| Docs/pages/docusaurus.config.ts | Removes the Docusaurus site configuration. |
| Docs/pages/docs/intro.mdx | Deletes the previous introductory docs landing page. |
| Docs/pages/docs/index.mdx | Adds a new docs page that now carries the intro/landing content. |
| Docs/pages/README.md | Removes contributor/deployment documentation for the old docs site. |
| Docs/pages/.gitignore | Removes ignore rules associated with the deleted Node/Docusaurus app. |
| .github/workflows/pages.yml | Deletes the old repository_dispatch-based docs deployment workflow. |
| .github/workflows/notify-docs-site.yml | Adds a workflow that dispatches a rebuild event to the external docs-site repo. |
| .github/workflows/build.yml | Removes the in-repo docs build/deploy job from the main CI workflow. |
| @@ -0,0 +1,22 @@ | |||
| name: Notify Docs Site | |||
Comment on lines
+16
to
+17
| - name: Dispatch extension-documentation-updated-event to Testably/Testably.Site | ||
| uses: peter-evans/repository-dispatch@v3 |
Comment on lines
238
to
240
| state: released | ||
| skip-label: | | ||
| state: released |
| @@ -0,0 +1,112 @@ | |||
| --- | |||
| title: Testably.Abstractions | |||
| slug: /abstractions/ | |||
| @@ -48,7 +48,6 @@ | |||
| <Folder Name="/_/.github/workflows/"> | |||
| <File Path=".github/workflows/build.yml" /> | |||
| <File Path=".github/workflows/ci.yml" /> | |||
|
This is addressed in release v6.3.0. |
This was referenced May 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request makes significant changes to the documentation site for
Testably.Abstractions. It removes the Docusaurus-based site from the repository, including all configuration, content, and deployment files. Additionally, it updates the GitHub Actions workflow to notify an external documentation site when documentation changes occur, instead of building and deploying the site directly from this repository.The most important changes are:
Documentation site removal:
docusaurus.config.ts,sidebars.ts), custom CSS, and thepackage.jsonfor the documentation site. This also removes the.gitignore, custom styles, and the mainREADME.mdfor the docs site.Workflow and deployment changes:
pages.yml) that previously built and deployed the documentation site to GitHub Pages.notify-docs-site.yml) that triggers a repository dispatch event to notify the externalTestably.Siterepository to rebuild the documentation site when documentation changes are pushed.These changes centralize documentation deployment and management in the external
Testably.Siterepository, rather than maintaining and deploying the documentation site within this repository.