From bd61811974c6ef4a903692e6e0f324fbe309b81d Mon Sep 17 00:00:00 2001 From: Connor England Date: Sat, 25 Jul 2026 20:18:20 -0500 Subject: [PATCH 1/3] docs: refresh public documentation mirror --- .github/CODEOWNERS | 3 + .github/dependabot.yml | 22 +++++ .github/workflows/ci.yml | 43 ++++++++ .github/workflows/clean-build-smoke.yml | 38 +++++++ .github/workflows/release.yml | 74 ++++++++++++++ LICENSE | 125 ++++++++++++------------ SOURCE_PROVENANCE.json | 40 ++++---- getting-started/install-windows.mdx | 2 +- getting-started/introduction.mdx | 2 +- getting-started/quickstart-cli.mdx | 4 +- guides/de-identify-real-messages.mdx | 2 +- guides/generate-realistic-test-data.mdx | 2 +- guides/monitor-mirth-with-loft.mdx | 2 +- guides/seed-database-with-flock.mdx | 2 +- mcp/overview.mdx | 10 +- 15 files changed, 273 insertions(+), 98 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/clean-build-smoke.yml create mode 100644 .github/workflows/release.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..45f5ba1 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Repository-local CODEOWNERS for PidgeonHealth/docs. + +* @PidgeonHealth/maintainers diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..e266930 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,22 @@ +# Dependabot config for PidgeonHealth/docs. +version: 2 +updates: + - package-ecosystem: npm + directory: / + schedule: + interval: weekly + open-pull-requests-limit: 5 + groups: + npm-minor-patch: + applies-to: version-updates + update-types: [minor, patch] + + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly + open-pull-requests-limit: 5 + groups: + actions-minor-patch: + applies-to: version-updates + update-types: [minor, patch] diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..281edda --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,43 @@ +# Read-only CI for PidgeonHealth/docs. +# +# Triggers only on pull_request (against the default branch) and workflow_dispatch. Never on +# push or pull_request_target. SHA provenance: ../../CONTRACT.md § 3. + +name: ci + +on: + pull_request: + workflow_dispatch: {} + +permissions: + contents: read + +concurrency: + group: ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build-and-check: + name: mintlify build + link check + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + with: + persist-credentials: false + + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 + with: + node-version: 22 + + - name: Install Mintlify CLI + run: npm install --global mintlify + + - name: Build + run: mintlify build + + - name: Broken-link check + run: mintlify broken-links + + - name: Navigation / search validity + run: mintlify validate --if-present diff --git a/.github/workflows/clean-build-smoke.yml b/.github/workflows/clean-build-smoke.yml new file mode 100644 index 0000000..2768ea2 --- /dev/null +++ b/.github/workflows/clean-build-smoke.yml @@ -0,0 +1,38 @@ +# Signed-out clean-build smoke for PidgeonHealth/docs (release policy § 5: "Node 22, Mintlify, +# navigation, search, and link checks pass"). +# +# Builds from a fresh anonymous clone only — no local-only content, no monorepo path. + +name: clean-build-smoke + +on: + workflow_dispatch: {} + +permissions: + contents: read + +jobs: + anonymous-clone-smoke: + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + with: + persist-credentials: false + fetch-depth: 1 + + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 + with: + node-version: 22 + + - name: Install Mintlify CLI + run: npm install --global mintlify + + - name: Build + run: mintlify build + + - name: Broken-link check + run: mintlify broken-links + + - name: Navigation / search validity + run: mintlify validate --if-present diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..c01f32f --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,74 @@ +# Protected deploy for PidgeonHealth/docs (the "Docs" door, release policy § 6-7): appends the +# deterministic pidgeon-docs projection commit and triggers a signed-out deployment. +# +# workflow_dispatch only; requires the `docs-deploy` protected environment (Connor-approved +# reviewer, restricted to the default branch per ../../environments/README.md). Defaults to +# dry_run=true; a real deploy requires both dry_run=false and confirm=deploy-docs. Mintlify's own +# GitHub App performs the actual hosting deploy on merge to the default branch; this job's job is +# the pre-deploy build/link/nav/claim gate, never a package publish, so no registry credential +# is read at all. + +name: release + +on: + workflow_dispatch: + inputs: + confirm: + description: 'Type "deploy-docs" to allow a real docs deploy.' + type: string + required: false + dry_run: + description: 'Build and check only; do not deploy.' + type: boolean + default: true + +permissions: + contents: read + +jobs: + preflight: + runs-on: ubuntu-latest + steps: + - name: Validate deploy intent + shell: bash + env: + CONFIRM: ${{ inputs.confirm }} + DRY_RUN: ${{ inputs.dry_run }} + run: | + if [[ "$DRY_RUN" == "false" && "$CONFIRM" != "deploy-docs" ]]; then + echo '::error::A real deploy requires confirm=deploy-docs.' + exit 1 + fi + echo "Deploy preflight accepted (dry_run=${DRY_RUN})." + + deploy-gate: + needs: preflight + runs-on: ubuntu-latest + environment: docs-deploy + timeout-minutes: 15 + steps: + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + with: + persist-credentials: false + + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 + with: + node-version: 22 + + - name: Install Mintlify CLI + run: npm install --global mintlify + + - name: Build + run: mintlify build + + - name: Broken-link check + run: mintlify broken-links + + - name: Deploy summary + run: | + if [[ "${{ inputs.dry_run }}" == "false" ]]; then + echo "Gate passed; Mintlify's GitHub App deploys on merge to the default branch." \ + | tee -a "$GITHUB_STEP_SUMMARY" + else + echo "Dry run: build/link checks only, no deploy." | tee -a "$GITHUB_STEP_SUMMARY" + fi diff --git a/LICENSE b/LICENSE index a32d475..73bed3e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,180 +1,179 @@ -# Mozilla Public License Version 2.0 +Mozilla Public License Version 2.0 -## 1. Definitions +1. Definitions -**1.1. "Contributor"** +1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. -**1.2. "Contributor Version"** +1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. -**1.3. "Contribution"** +1.3. "Contribution" means Covered Software of a particular Contributor. -**1.4. "Covered Software"** +1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. -**1.5. "Incompatible With Secondary Licenses"** +1.5. "Incompatible With Secondary Licenses" means -- **(a)** that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or -- **(b)** that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. +- (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or +- (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. -**1.6. "Executable Form"** +1.6. "Executable Form" means any form of the work other than Source Code Form. -**1.7. "Larger Work"** +1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. -**1.8. "License"** +1.8. "License" means this document. -**1.9. "Licensable"** +1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. -**1.10. "Modifications"** +1.10. "Modifications" means any of the following: -- **(a)** any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or -- **(b)** any new file in Source Code Form that contains any Covered Software. +- (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or +- (b) any new file in Source Code Form that contains any Covered Software. -**1.11. "Patent Claims" of a Contributor** +1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. -**1.12. "Secondary License"** +1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. -**1.13. "Source Code Form"** +1.13. "Source Code Form" means the form of the work preferred for making modifications. -**1.14. "You" (or "Your")** +1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. -## 2. License Grants and Conditions +2. License Grants and Conditions -### 2.1. Grants +2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: -- **(a)** under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and -- **(b)** under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. +- (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and +- (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. -### 2.2. Effective Date +2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. -### 2.3. Limitations on Grant Scope +2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: -- **(a)** for any code that a Contributor has removed from Covered Software; or -- **(b)** for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or -- **(c)** under Patent Claims infringed by Covered Software in the absence of its Contributions. +- (a) for any code that a Contributor has removed from Covered Software; or +- (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or +- (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). -### 2.4. Subsequent Licenses +2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). -### 2.5. Representation +2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. -### 2.6. Fair Use +2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. -### 2.7. Conditions +2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. -## 3. Responsibilities +3. Responsibilities -### 3.1. Distribution of Source Form +3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. -### 3.2. Distribution of Executable Form +3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: -- **(a)** such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and -- **(b)** You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. +- (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and +- (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. -### 3.3. Distribution of a Larger Work +3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). -### 3.4. Notices +3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. -### 3.5. Application of Additional Terms +3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. -## 4. Inability to Comply Due to Statute or Regulation +4. Inability to Comply Due to Statute or Regulation If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. -## 5. Termination +5. Termination -**5.1.** The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. +5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. -**5.2.** If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. +5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. -**5.3.** In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. -## 6. Disclaimer of Warranty +6. Disclaimer of Warranty -> **Covered Software is provided under this License on an "as is" basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.** +Covered Software is provided under this License on an "as is" basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer. -## 7. Limitation of Liability +7. Limitation of Liability -> **Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.** +Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. -## 8. Litigation +8. Litigation Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. -## 9. Miscellaneous +9. Miscellaneous This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. -## 10. Versions of the License +10. Versions of the License -### 10.1. New Versions +10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. -### 10.2. Effect of New Versions +10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. -### 10.3. Modified Versions +10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). -### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses +10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. -## Exhibit A - Source Code Form License Notice +Exhibit A - Source Code Form License Notice + -``` This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/. -``` + If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. -## Exhibit B - "Incompatible With Secondary Licenses" Notice +Exhibit B - "Incompatible With Secondary Licenses" Notice + -``` This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. -``` diff --git a/SOURCE_PROVENANCE.json b/SOURCE_PROVENANCE.json index 162b4d4..e4cc51e 100644 --- a/SOURCE_PROVENANCE.json +++ b/SOURCE_PROVENANCE.json @@ -2,11 +2,11 @@ "schemaVersion": 1, "surface": "docs", "targetRepository": "PidgeonHealth/docs", - "upstreamSha": "54adac98b9e9a0296e11f00cc99d7752c691bc0c", + "upstreamSha": "ae6bba0018fa2d24395c8c72ce381d5445ed628a", "sourceRef": "origin/main", "manifestSha256": "40f7b66a131b5b6765bcfaac35cabaa47d69cac0e04f444cc9a96849b0437b5c", "projectorPath": "scripts/public-release/project.mjs", - "projectorSha256": "c96f26914304c9f5c369443192b943c8e197f5efb5fe2c2b73fcc923c97a7043", + "projectorSha256": "f45498479728274e9a1e844bd83ca25a05c35b17c487e0544ffbfd2e10c942b8", "compositionManifestPath": null, "compositionManifestSha256": null, "secretScanner": "pidgeon-public-projection-v1", @@ -29,8 +29,8 @@ }, { "path": "LICENSE", - "sha256": "aa1c351f9d2cbfc60989b46c56cd409babf7ab997da9a16150472bba1855f480", - "size": 15115, + "sha256": "fd590ce7c5df3e6a1f38481cfc0c244b3a192c8a4c79fd7cf95676ef2c81cf34", + "size": 14848, "mode": "100644", "source": "config/public-projections/scaffold/shared/LICENSE", "license": "MPL-2.0" @@ -309,16 +309,16 @@ }, { "path": "getting-started/install-windows.mdx", - "sha256": "99a34cbab6c9005736a64c9aa27721fd15fe0bc8dadcd996178eb7496b51e465", - "size": 4622, + "sha256": "e57c20a9ec583201507ab3632ab65a7de2fe008534cd81c211e3da123e2dcb6e", + "size": 4638, "mode": "100644", "source": "pidgeon-docs/getting-started/install-windows.mdx", "license": "Pidgeon-Public-Documentation" }, { "path": "getting-started/introduction.mdx", - "sha256": "fc8e691fc35c8c6f611c114323ccd01551b1c8395d4f5e52e6b19c52aff5ec60", - "size": 4593, + "sha256": "9f2605ab71324fad1434fc9b7ec29568a3102581acce7320875ad54adb14e86f", + "size": 4662, "mode": "100644", "source": "pidgeon-docs/getting-started/introduction.mdx", "license": "Pidgeon-Public-Documentation" @@ -357,8 +357,8 @@ }, { "path": "getting-started/quickstart-cli.mdx", - "sha256": "4bcf725d6bb40e7836a86a835d337f58e39703f10fca5eec1ca41eda5b80bcd5", - "size": 4023, + "sha256": "ee6e75a9a11fc2b25dbf7b146fc2cf464a597b3da8c42c90f80587fae7621146", + "size": 3884, "mode": "100644", "source": "pidgeon-docs/getting-started/quickstart-cli.mdx", "license": "Pidgeon-Public-Documentation" @@ -381,32 +381,32 @@ }, { "path": "guides/de-identify-real-messages.mdx", - "sha256": "72d87600ad76daf1e91e5f52a5e93a09332fd481862c1a29d512bc1f47db22f0", - "size": 3710, + "sha256": "a05ab9205d58bac803d11a544ba48575c40f811ddd1c9a52b9beb8d3d0e14880", + "size": 3743, "mode": "100644", "source": "pidgeon-docs/guides/de-identify-real-messages.mdx", "license": "Pidgeon-Public-Documentation" }, { "path": "guides/generate-realistic-test-data.mdx", - "sha256": "e296c0d6e5c615517d479999e803dca1bd014ac6398890cae27d6afdaf367c2d", - "size": 3350, + "sha256": "2c52393f7dd6968676d30d17795877c0a46c07b3fedd72837d940e7fac7202c5", + "size": 3383, "mode": "100644", "source": "pidgeon-docs/guides/generate-realistic-test-data.mdx", "license": "Pidgeon-Public-Documentation" }, { "path": "guides/monitor-mirth-with-loft.mdx", - "sha256": "20c2067c0055d1237dede84c878dd53064ecfab6ad8c0cc75123acaee4039f86", - "size": 3751, + "sha256": "53003b9a10fcae411aa0b7a928dfbc5f6b0ceb1fa8515ccbd62c0e2a7b97c8bc", + "size": 3784, "mode": "100644", "source": "pidgeon-docs/guides/monitor-mirth-with-loft.mdx", "license": "Pidgeon-Public-Documentation" }, { "path": "guides/seed-database-with-flock.mdx", - "sha256": "0dd7139e95d0cf96b411378de6d4b16b7d2d018199bbe754f333a1e4ce6562ae", - "size": 3854, + "sha256": "6f8b1236e30903ec26e8f0e696fc543b89bba4b324524865142c529c98821107", + "size": 3887, "mode": "100644", "source": "pidgeon-docs/guides/seed-database-with-flock.mdx", "license": "Pidgeon-Public-Documentation" @@ -533,8 +533,8 @@ }, { "path": "mcp/overview.mdx", - "sha256": "d54d71600211578b9b8b39d97fa76a7aa357a80790b33e1c1db0b0518ff041c3", - "size": 5931, + "sha256": "53506bd93254492f5de891f36b82bd3c77f9fb33765ba725e90dcea37e8189ce", + "size": 5875, "mode": "100644", "source": "pidgeon-docs/mcp/overview.mdx", "license": "Pidgeon-Public-Documentation" diff --git a/getting-started/install-windows.mdx b/getting-started/install-windows.mdx index 663e9da..d1ce8da 100644 --- a/getting-started/install-windows.mdx +++ b/getting-started/install-windows.mdx @@ -26,7 +26,7 @@ Current beta release: `0.2.0-beta.1`. ```powershell - Get-FileHash .\Post_0.2.0-beta.1_x64-setup.exe -Algorithm SHA256 + Get-FileHash .\Pidgeon-Post-0.2.0-beta.1-windows-x64-setup.exe -Algorithm SHA256 ``` Compare the output against the checksum shown in the catalog. If they differ, do not run the installer: re-download, and contact [support@pidgeon.health](mailto:support@pidgeon.health) if it still differs. diff --git a/getting-started/introduction.mdx b/getting-started/introduction.mdx index fd667d7..7c5e2d5 100644 --- a/getting-started/introduction.mdx +++ b/getting-started/introduction.mdx @@ -62,7 +62,7 @@ Each product has its own buyer and budget — this is a shared engine with a ret ## Free CLI, desktop apps for everyone else -- **CLI** — Always free. `dotnet tool install -g pidgeon` and you're generating messages in under a minute. +- **CLI** — Always free. Install the `Pidgeon.CLI` tool with `dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1` and you're generating messages in under a minute. - **Desktop apps** — Post, Flock, Loft, and Migrate for the majority who'd rather point and click. Post's core loop (generate, validate, conform) works with no account; Post Pro starts at $29/mo, and Flock, Loft, and Migrate require a Pidgeon account sign-in. diff --git a/getting-started/quickstart-cli.mdx b/getting-started/quickstart-cli.mdx index 315441a..4ae8ceb 100644 --- a/getting-started/quickstart-cli.mdx +++ b/getting-started/quickstart-cli.mdx @@ -5,8 +5,6 @@ description: Install the CLI, generate and validate your first HL7 message, run The CLI is one binary that exposes generate, validate, conform, and de-identify from a terminal. It follows the Unix convention (`0` success, non-zero failure), so every command below drops into a CI pipeline as-is. -{/* BETA-GATE(CLI distribution): the public NuGet package ships with the beta. Confirm the package ID and version on nuget.org at beta publish, then remove this note. */} - ## Prerequisites - [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) or later @@ -14,7 +12,7 @@ The CLI is one binary that exposes generate, validate, conform, and de-identify ```bash - dotnet tool install -g pidgeon + dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1 ``` Verify the installation: diff --git a/guides/de-identify-real-messages.mdx b/guides/de-identify-real-messages.mdx index 48d4b19..c847ce5 100644 --- a/guides/de-identify-real-messages.mdx +++ b/guides/de-identify-real-messages.mdx @@ -9,7 +9,7 @@ De-identification assists with HIPAA compliance but does not guarantee it. Alway ## Prerequisites -- Pidgeon CLI installed (`dotnet tool install -g pidgeon`) +- Pidgeon CLI installed (`dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1`) - A directory of real HL7 messages to de-identify ## Basic de-identification diff --git a/guides/generate-realistic-test-data.mdx b/guides/generate-realistic-test-data.mdx index 53483e3..ddf4978 100644 --- a/guides/generate-realistic-test-data.mdx +++ b/guides/generate-realistic-test-data.mdx @@ -5,7 +5,7 @@ description: Go from zero to a full test dataset in under 5 minutes — HL7, FHI ## Prerequisites -- Pidgeon CLI installed (`dotnet tool install -g pidgeon`) +- Pidgeon CLI installed (`dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1`) - Optionally: a vendor profile from real sample messages ## Generate your first messages diff --git a/guides/monitor-mirth-with-loft.mdx b/guides/monitor-mirth-with-loft.mdx index 6e34aa4..85fb6a2 100644 --- a/guides/monitor-mirth-with-loft.mdx +++ b/guides/monitor-mirth-with-loft.mdx @@ -5,7 +5,7 @@ description: Stop finding out about interface failures from clinical staff. Poin ## Prerequisites -- Pidgeon CLI installed (`dotnet tool install -g pidgeon`) +- Pidgeon CLI installed (`dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1`) - Access to Mirth Connect's file writer output directories - A vendor profile for your message patterns (optional but recommended) diff --git a/guides/seed-database-with-flock.mdx b/guides/seed-database-with-flock.mdx index 20bf99e..ec17cf6 100644 --- a/guides/seed-database-with-flock.mdx +++ b/guides/seed-database-with-flock.mdx @@ -7,7 +7,7 @@ An empty test database doesn't catch real bugs. A database full of copied produc ## Prerequisites -- Pidgeon CLI installed (`dotnet tool install -g pidgeon`) +- Pidgeon CLI installed (`dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1`) - A database with an existing schema (PostgreSQL, MySQL, or SQL Server) - Database credentials with read/write access diff --git a/mcp/overview.mdx b/mcp/overview.mdx index 5439a24..6202659 100644 --- a/mcp/overview.mdx +++ b/mcp/overview.mdx @@ -3,7 +3,7 @@ title: MCP Server description: Drive Pidgeon's HL7 / FHIR / NCPDP engine from Claude, Cursor, VS Code, or any MCP client. Two transport modes, tier-gated tools, on-device AI by default. --- -The Pidgeon MCP server (`@pidgeonhealth/mcp`) exposes the same generate / validate / conform / seed / monitor operations you run in the CLI and the desktop apps as agent tools over the [Model Context Protocol](https://modelcontextprotocol.io). One surface, two drivers: a human works the panes in the apps; an agent reads those same operations over MCP. +The public Pidgeon MCP adapter (`@pidgeonhealth/pidgeon-mcp`) exposes the community capabilities of the Pidgeon CLI over the [Model Context Protocol](https://modelcontextprotocol.io). In CLI mode it launches the local `pidgeon` command; in Bridge mode it connects to a running desktop Bridge and registers only the capabilities that Bridge advertises. The MCP transport is the delivery mechanism, not the entitlement. The free/paid line is enforced at Bridge authentication + a validated subscription — not at the transport. A free agent loop is never broken by a hard error; it degrades gracefully. @@ -13,12 +13,12 @@ The Pidgeon MCP server (`@pidgeonhealth/mcp`) exposes the same generate / valida ## Install -The server is an npm package that shells out to the Pidgeon CLI (CLI mode) or talks to a running desktop app's Bridge (Bridge mode). +The server is an npm package that shells out to the Pidgeon CLI (CLI mode) or talks to a running desktop app's Bridge (Bridge mode). The beta release is `0.1.0-beta.1`. ```bash - dotnet tool install -g pidgeon + dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1 ``` @@ -29,7 +29,7 @@ The server is an npm package that shells out to the Pidgeon CLI (CLI mode) or ta "mcpServers": { "pidgeon": { "command": "npx", - "args": ["-y", "@pidgeonhealth/mcp"], + "args": ["-y", "@pidgeonhealth/pidgeon-mcp@0.1.0-beta.1"], "env": { "PIDGEON_MODE": "cli" } @@ -40,8 +40,6 @@ The server is an npm package that shells out to the Pidgeon CLI (CLI mode) or ta -The public package publishes with the beta. Confirm the package name and version on npm at beta publish before pinning a version. - ## Two transport modes The `PIDGEON_MODE` environment variable selects the transport, and the transport determines which tools register. From f7acf6686e6311a734657fe8e6ad83bbd71f7ec6 Mon Sep 17 00:00:00 2001 From: Connor England Date: Sat, 25 Jul 2026 20:21:48 -0500 Subject: [PATCH 2/3] docs: use supported Mintlify validation command --- .github/workflows/ci.yml | 4 ++-- .github/workflows/clean-build-smoke.yml | 4 ++-- .github/workflows/release.yml | 4 ++-- SOURCE_PROVENANCE.json | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 281edda..3f8aadc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,8 +33,8 @@ jobs: - name: Install Mintlify CLI run: npm install --global mintlify - - name: Build - run: mintlify build + - name: Build and validate + run: mintlify validate - name: Broken-link check run: mintlify broken-links diff --git a/.github/workflows/clean-build-smoke.yml b/.github/workflows/clean-build-smoke.yml index 2768ea2..8c0fac9 100644 --- a/.github/workflows/clean-build-smoke.yml +++ b/.github/workflows/clean-build-smoke.yml @@ -28,8 +28,8 @@ jobs: - name: Install Mintlify CLI run: npm install --global mintlify - - name: Build - run: mintlify build + - name: Build and validate + run: mintlify validate - name: Broken-link check run: mintlify broken-links diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c01f32f..e99b33d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -58,8 +58,8 @@ jobs: - name: Install Mintlify CLI run: npm install --global mintlify - - name: Build - run: mintlify build + - name: Build and validate + run: mintlify validate - name: Broken-link check run: mintlify broken-links diff --git a/SOURCE_PROVENANCE.json b/SOURCE_PROVENANCE.json index e4cc51e..f3e11d4 100644 --- a/SOURCE_PROVENANCE.json +++ b/SOURCE_PROVENANCE.json @@ -2,7 +2,7 @@ "schemaVersion": 1, "surface": "docs", "targetRepository": "PidgeonHealth/docs", - "upstreamSha": "ae6bba0018fa2d24395c8c72ce381d5445ed628a", + "upstreamSha": "3d97b68c3196d96ca917c9c2d348bad16b2aa3d3", "sourceRef": "origin/main", "manifestSha256": "40f7b66a131b5b6765bcfaac35cabaa47d69cac0e04f444cc9a96849b0437b5c", "projectorPath": "scripts/public-release/project.mjs", From d384dd7de7d1d18eb1cf81a49477dc3bf41c864b Mon Sep 17 00:00:00 2001 From: Connor England Date: Sat, 25 Jul 2026 20:24:23 -0500 Subject: [PATCH 3/3] docs: refresh projection provenance and security policy --- SECURITY.md | 6 +++--- SOURCE_PROVENANCE.json | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index 85450b4..a79ac6d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -13,9 +13,9 @@ Two private channels: 1. **Preferred — GitHub Security Advisory.** Open a private advisory from this repository's **Security → Advisories** tab. This creates an encrypted, audited channel and lets us collaborate on a fix without early disclosure. -2. **Email.** `security@pidgeon.health`. Encrypt with our PGP key (fingerprint published at - ) if you can; unencrypted reports are also - accepted. +2. **Email.** `security@pidgeon.health`. Encrypt with our PGP key (see the [published PGP + key](https://pidgeon.health/.well-known/pgp-key.asc)) if you can; unencrypted reports are + also accepted. Please include: diff --git a/SOURCE_PROVENANCE.json b/SOURCE_PROVENANCE.json index f3e11d4..34c0b73 100644 --- a/SOURCE_PROVENANCE.json +++ b/SOURCE_PROVENANCE.json @@ -2,7 +2,7 @@ "schemaVersion": 1, "surface": "docs", "targetRepository": "PidgeonHealth/docs", - "upstreamSha": "3d97b68c3196d96ca917c9c2d348bad16b2aa3d3", + "upstreamSha": "6d6564cf95819363f4ff13b434ca8cdaf228cb97", "sourceRef": "origin/main", "manifestSha256": "40f7b66a131b5b6765bcfaac35cabaa47d69cac0e04f444cc9a96849b0437b5c", "projectorPath": "scripts/public-release/project.mjs", @@ -53,8 +53,8 @@ }, { "path": "SECURITY.md", - "sha256": "8a512507d3ea20d64014b4cc18d8ae0ff3d8e4dd1bc20b99ee1f59b1451f0034", - "size": 2648, + "sha256": "324e616e71df9fb955ed6033a94c3f479cb339601e076ba7643797a2c46cf170", + "size": 2650, "mode": "100644", "source": "config/public-projections/scaffold/shared/SECURITY.md", "license": "Pidgeon-Public-Documentation"