Skip to content

Commit e0d820a

Browse files
committed
add deepwiki mcp tool
1 parent 9809189 commit e0d820a

File tree

4 files changed

+31
-11
lines changed

4 files changed

+31
-11
lines changed

src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# copilot-instructions.md
22

3-
## Architecture & Project Structure
3+
### Architecture & Project Structure
44

55
- **Client Projects**: Multiple platform-specific clients sharing core infrastructure
66
- `Client.Core`: Blazor pages, shared components, service, typescript and SCSS files.
@@ -16,8 +16,6 @@
1616

1717
- **Boilerplate.Tests**: Integration api and UI tests using Playwright and MSTest.
1818

19-
## Technology Stack
20-
2119
### Technologies
2220
- **C# 13.0**
2321
- **ASP.NET Core 9.0**
@@ -33,8 +31,6 @@
3331
- **TypeScript**: Type-safe JavaScript development
3432
- **SCSS**: Advanced CSS preprocessing
3533

36-
## Development Guidelines
37-
3834
### Code Style & Conventions
3935
- **C# 13.0**: Use latest language features
4036
- **Nullable Reference Types**: Enabled project-wide
@@ -68,12 +64,25 @@ dotnet test
6864
### GitHub Codespaces Support
6965
The project is optimized for GitHub Codespaces development with pre-configured container support.
7066

71-
## Best Practices
67+
### Best Practices
7268

7369
1. **Follow the established project structure**
7470
2. **Use Bit.BlazorUI components** - leverage the framework's built-in components and utilities
7571
3. **Follow nullable reference type conventions** - all new code should be nullable-aware
7672
4. **Use dependency injection** - leverage the built-in DI container for service registration
7773
5. **Implement proper logging** - use structured logging throughout the application
7874
6. **Follow security best practices** - use proper authentication and authorization patterns
79-
7. **Async Programming** - prefer async/await for I/O-bound operations, avoid blocking calls
75+
7. **Async Programming** - prefer async/await for I/O-bound operations, avoid blocking calls
76+
77+
### Tool Usage: DeepWiki for BitPlatform
78+
You have a special tool, `deepwiki`, for accessing documentation about the `bitfoundation/bitplatform` library.
79+
80+
**RULE:** If a question mentions or implies the use of a "Bit" component (like `BitButton`, `BitTooltip`, `BitTextField`), or refers to the "bitplatform" or "bit Boilerplate",
81+
you **MUST** use the `deepwiki` tool to find the correct implementation before writing any code. Do not use generic HTML/CSS/JS solutions for these components.
82+
83+
**Command:**
84+
`deepwiki fetch bitfoundation/bitplatform`
85+
86+
**Example Usage:**
87+
* **User Prompt:** "How do I make a BitButton disabled?"
88+
* **Your Action:** First, run `deepwiki fetch bitfoundation/bitplatform to search for How do I make a BitButton disabled?`. Then, use the documentation to answer the user.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"servers": {
3+
"DeepWiki": {
4+
"type": "sse",
5+
"url": "https://mcp.deepwiki.com/sse"
6+
}
7+
}
8+
}

src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<PackageVersion Include="Fido2.AspNet" Version="4.0.0-beta.16" />
1414
<PackageVersion Include="Fido2.Models" Version="4.0.0-beta.16" />
1515
<PackageVersion Include="HtmlSanitizer" Version="9.0.886" />
16-
<PackageVersion Include="libphonenumber-csharp" Version="9.0.7" />
16+
<PackageVersion Include="libphonenumber-csharp" Version="9.0.8" />
1717
<PackageVersion Include="Meziantou.Framework.Win32.Jobs" Version="3.4.3" />
1818
<PackageVersion Include="Microsoft.AspNetCore.Components.Authorization" Version="9.0.6" />
1919
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="9.0.6" />
@@ -40,9 +40,9 @@
4040
<!--/+:msbuild-conditional:noEmit -->
4141
<PackageVersion Include="Hangfire.AspNetCore" Version="1.8.20" />
4242
<PackageVersion Include="Hangfire.EntityFrameworkCore" Version="0.7.0" />
43-
<PackageVersion Condition=" '$(sentry)' == 'true' OR '$(sentry)' == '' " Include="Sentry.AspNetCore" Version="5.11.1" />
44-
<PackageVersion Condition=" '$(sentry)' == 'true' OR '$(sentry)' == '' " Include="Sentry.Extensions.Logging" Version="5.11.1" />
45-
<PackageVersion Condition=" '$(sentry)' == 'true' OR '$(sentry)' == '' " Include="Sentry.Maui" Version="5.11.1" />
43+
<PackageVersion Condition=" '$(sentry)' == 'true' OR '$(sentry)' == '' " Include="Sentry.AspNetCore" Version="5.11.2" />
44+
<PackageVersion Condition=" '$(sentry)' == 'true' OR '$(sentry)' == '' " Include="Sentry.Extensions.Logging" Version="5.11.2" />
45+
<PackageVersion Condition=" '$(sentry)' == 'true' OR '$(sentry)' == '' " Include="Sentry.Maui" Version="5.11.2" />
4646
<PackageVersion Include="Xamarin.AndroidX.Activity" Version="1.10.1.2" />
4747
<PackageVersion Include="Xamarin.AndroidX.Activity.Ktx" Version="1.10.1.2" />
4848
<PackageVersion Include="Xamarin.AndroidX.Collection" Version="1.5.0.2" />

src/Websites/WikiDocs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,6 @@ The following questions give you an idea what kind of questions can be answered
3939
[How does `passwordless authentication` work in Boilerplate, particularly in Blazor Hybrid versions of the app, given that this feature is browser-only?](https://wiki.bitplatform.dev/search/how-does-passwordless-authenti_79dfa280-bcff-4a2e-9178-504ce32b3082)
4040

4141
[How does using `embeddings` with the PostgreSQL `vector` extension enable product search functionality via LINQ and Entity Framework Core?](https://wiki.bitplatform.dev/search/describe-how-product-embedding_c1df611d-feeb-48e2-918a-aa75df00c771)
42+
43+
## copilot-instructions.md
44+

0 commit comments

Comments
 (0)