-
Notifications
You must be signed in to change notification settings - Fork 562
Update documentation configuration #86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
53cedda
Docs configuration
localden a67e755
Update docs/index.md
localden c19de5c
Update the configuration
localden 05d25ac
Merge branch 'ddelimarsky/docs' of https://github.com/modelcontextpro…
localden 350d4b1
Update docs/docfx.json
localden bac970c
Update config
localden 72377fe
Merge branch 'ddelimarsky/docs' of https://github.com/modelcontextpro…
localden a7b80d7
Update icons, use Makefile, remove warnings
eiriktsarpalis 912d141
Use a link that passes markdown link validation
eiriktsarpalis b2ac242
remove working directory
eiriktsarpalis 1e44b84
Merge branch 'main' into ddelimarsky/docs
eiriktsarpalis b7a8162
Merge branch 'main' into ddelimarsky/docs
eiriktsarpalis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "version": 1, | ||
| "isRoot": true, | ||
| "tools": { | ||
| "docfx": { | ||
| "version": "2.78.3", | ||
| "commands": [ | ||
| "docfx" | ||
| ], | ||
| "rollForward": false | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| actions: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| publish-docs: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: .NET Setup | ||
| uses: actions/setup-dotnet@v4 | ||
| with: | ||
| dotnet-version: 9.x | ||
|
|
||
| - name: Generate documentation | ||
| run: make generate-docs | ||
|
|
||
| - name: Upload Pages artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: 'artifacts/_site' | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -73,3 +73,7 @@ _NCrunch_* | |
| nCrunchTemp_* | ||
|
|
||
| *.orig | ||
|
|
||
| # Auto-generated documentation | ||
| docs/_site | ||
| docs/api | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| SOURCE_DIRECTORY := $(dir $(realpath $(lastword $(MAKEFILE_LIST)))) | ||
| ARTIFACT_PATH := $(SOURCE_DIRECTORY)artifacts | ||
| DOCS_PATH := $(SOURCE_DIRECTORY)docs | ||
| CONFIGURATION ?= Release | ||
|
|
||
| clean: | ||
| dotnet clean | ||
| rm -rf $(ARTIFACT_PATH)/* | ||
| rm -rf $(DOCS_PATH)/api | ||
|
|
||
| restore: | ||
| dotnet tool restore | ||
| dotnet restore | ||
|
|
||
| build: restore | ||
| dotnet build --no-restore --configuration $(CONFIGURATION) | ||
|
|
||
| test: build | ||
| dotnet test \ | ||
| --no-build \ | ||
| --configuration $(CONFIGURATION) \ | ||
| --filter '(Execution!=Manual)' \ | ||
| --blame \ | ||
| --diag "$(ARTIFACT_PATH)/diag.txt" \ | ||
| --logger "trx" \ | ||
| --collect "Code Coverage;Format=cobertura" \ | ||
| --results-directory $(ARTIFACT_PATH)/test-results \ | ||
| -- \ | ||
| RunConfiguration.CollectSourceInformation=true | ||
|
|
||
| generate-docs: clean restore | ||
| dotnet build --no-restore --configuration Release | ||
| dotnet docfx $(DOCS_PATH)/docfx.json | ||
|
|
||
| serve-docs: generate-docs | ||
| dotnet docfx serve $(ARTIFACT_PATH)/_site --port 8080 | ||
|
|
||
| .DEFAULT_GOAL := build |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| { | ||
| "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json", | ||
| "metadata": [ | ||
| { | ||
| "src": [ | ||
| { | ||
| "src": "../src", | ||
| "files": [ | ||
| "**/*.csproj" | ||
| ] | ||
| } | ||
| ], | ||
| "output": "api" | ||
| } | ||
| ], | ||
| "build": { | ||
| "content": [ | ||
| { | ||
| "files": [ | ||
| "**/*.{md,yml}" | ||
| ], | ||
| "exclude": [ | ||
| "_site/**" | ||
| ] | ||
| } | ||
| ], | ||
| "resource": [ | ||
| { | ||
| "files": [ | ||
| "images/**" | ||
| ] | ||
| } | ||
| ], | ||
| "output": "../artifacts/_site", | ||
| "template": [ | ||
| "default", | ||
| "modern" | ||
| ], | ||
| "globalMetadata": { | ||
| "_appName": "MCP C# SDK", | ||
| "_appTitle": "MCP C# SDK", | ||
| "_appLogoPath": "images/mcp.svg", | ||
| "_appFaviconPath": "images/favicon.ico", | ||
| "_enableSearch": true, | ||
| "pdf": false | ||
| } | ||
| } | ||
| } | ||
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| _layout: landing | ||
| --- | ||
|
|
||
| # Overview | ||
|
|
||
| The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers. Please visit our [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html) for more details on available functionality. | ||
|
|
||
| ## About MCP | ||
|
|
||
| The Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It enables secure integration between LLMs and various data sources and tools. | ||
|
|
||
| For more information about MCP: | ||
|
|
||
| - [Official Documentation](https://modelcontextprotocol.io/) | ||
| - [Protocol Specification](https://spec.modelcontextprotocol.io/) | ||
| - [GitHub Organization](https://github.com/modelcontextprotocol) | ||
|
|
||
| For how-to guides, tutorials, and additional guidance, refer to the [official MCP documentation](https://modelcontextprotocol.io/). | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](https://github.com/modelcontextprotocol/csharp-sdk/blob/main/LICENSE). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| items: | ||
| - name: API Docs | ||
| href: api/ModelContextProtocol.yml | ||
| - name: Github | ||
| href: https://github.com/ModelContextProtocol/csharp-sdk |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.