diff --git a/.github/.linkspector.yml b/.github/.linkspector.yml new file mode 100644 index 000000000000..89cf32cfb050 --- /dev/null +++ b/.github/.linkspector.yml @@ -0,0 +1,21 @@ +dirs: + - . +ignorePatterns: + - pattern: "/github/" + - pattern: "./actions" + - pattern: "./blob" + - pattern: "./issues" + - pattern: "./discussions" + - pattern: "./pulls" + - pattern: "^http://localhost" + - pattern: "^https://localhost" + - pattern: "^https://platform.openai.com" + - pattern: "^https://outlook.office.com/bookings" +baseUrl: https://github.com/microsoft/semantic-kernel/ +aliveStatusCodes: + - 200 + - 206 + - 429 + - 500 + - 503 +useGitIgnore: true diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json deleted file mode 100644 index 50ada4911de6..000000000000 --- a/.github/workflows/markdown-link-check-config.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "/github/" - }, - { - "pattern": "./actions" - }, - { - "pattern": "./blob" - }, - { - "pattern": "./issues" - }, - { - "pattern": "./discussions" - }, - { - "pattern": "./pulls" - }, - { - "pattern": "^http://localhost" - }, - { - "pattern": "^https://localhost" - }, - { - "pattern": "^https://platform.openai.com" - }, - { - "pattern": "^https://outlook.office.com/bookings" - } - ], - "timeout": "20s", - "retryOn429": true, - "retryCount": 3, - "fallbackRetryDelay": "30s", - "aliveStatusCodes": [200, 206, 429, 500, 503] -} diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml index 7e95bdaec051..35a6f6d7076d 100644 --- a/.github/workflows/markdown-link-check.yml +++ b/.github/workflows/markdown-link-check.yml @@ -15,9 +15,11 @@ jobs: steps: - uses: actions/checkout@v4 - # Checks the status of hyperlinks in .md files in verbose mode - - name: Check links - uses: gaurav-nelson/github-action-markdown-link-check@v1 + # Checks the status of hyperlinks in all files + - name: Run linkspector + uses: umbrelladocs/action-linkspector@v1 with: - use-verbose-mode: "yes" - config-file: ".github/workflows/markdown-link-check-config.json" + reporter: local + filter_mode: nofilter + fail_on_error: true + config_file: ".github/.linkspector.yml" diff --git a/docs/decisions/0032-agents.md b/docs/decisions/0032-agents.md index 250b35e8bb75..6e1da34b27fe 100644 --- a/docs/decisions/0032-agents.md +++ b/docs/decisions/0032-agents.md @@ -60,7 +60,7 @@ An _Agent_ can be of various modalities. Modalities are asymmetrical with regar - _Agent Framework_ shall be extensible so that other libraries can build their own agents and chat experiences. - _Agent Framework_ shall be as simple as possible to facilitate extensibility. - _Agent Framework_ shall encapsulate complexity within implementation details, not calling patterns. -- _Agent_ abstraction shall support different modalities (see [Agent Modalities](#Agent-Modalities:) section). +- _Agent_ abstraction shall support different modalities (see [Agent Modalities](#agent-modalities) section). - An _Agent_ of any modality shall be able to interact with an _Agent_ of any other modality. - An _Agent_ shall be able to support its own modality requirements. (Specialization) - _Agent_ input and output shall align to SK content type `ChatMessageContent`. diff --git a/python/README.md b/python/README.md index 0624f34a032f..6425fd5d7698 100644 --- a/python/README.md +++ b/python/README.md @@ -18,7 +18,7 @@ python -m pip install --upgrade semantic-kernel[all] ## OpenAI / Azure OpenAI API keys Make sure you have an -[OpenAI API Key](https://platform.openai.com) or +[OpenAI API Key](https://platform.openai.com/) or [Azure OpenAI service key](https://learn.microsoft.com/azure/cognitive-services/openai/quickstart?pivots=rest-api) There are two methods to manage keys, secrets, and endpoints: diff --git a/python/samples/getting_started_with_agents/README.md b/python/samples/getting_started_with_agents/README.md index 6028db397406..b34d1d56c05d 100644 --- a/python/samples/getting_started_with_agents/README.md +++ b/python/samples/getting_started_with_agents/README.md @@ -34,7 +34,7 @@ Example|Description ## Configuring the Kernel Similar to the Semantic Kernel Python concept samples, it is necessary to configure the secrets -and keys used by the kernel. See the follow "Configuring the Kernel" [guide](../concepts/README.md#configuring-the-kernell) for +and keys used by the kernel. See the follow "Configuring the Kernel" [guide](../concepts/README.md#configuring-the-kernel) for more information. ## Running Concept Samples