docs: AI agent onboarding — add CLAUDE.md and ai_instructions.md - #2
Merged
Conversation
Introduce two AI-facing onboarding docs at the repo root so automated agents have a canonical reference for this library's stack, conventions, and procedural rules. - CLAUDE.md: high-level overview (tech stack, solution structure, build commands, conventions, file locations, gotchas, related repos). - ai_instructions.md: strict procedural rules (mission, architecture patterns, DTO/serialization/testing rules, forbidden patterns). Modeled after the equivalent files in the sibling libraries BexioApiNet and CashCtrlApiNet, but tailored to WebSmsNet's actual stack (net9.0 / C# 13 / xUnit + FluentAssertions) and its single-POST, webhook-driven API surface. Refs #1
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
2 participants
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.
Summary
CLAUDE.mdwith stack overview, solution structure, build/test commands, coding conventions, and AI workflow hints for this repoai_instructions.mdwith strict procedural rules, architecture patterns, DTO/serialization rules, testing constraints, forbidden patterns, and persona routing guidance.gitignoreto properly exclude.ai-context/runtime context directory on its own lineBoth files were modelled after the equivalent docs in BexioApiNet and CashCtrlApiNet, but tailored to WebSmsNet's actual stack (net9.0 / C# 13 / xUnit + FluentAssertions) and its single-POST, webhook-driven API surface.
The doc-writer agent verified the documentation accurately reflects:
.NET 9+LangVersion 13targetSystem.Text.JsonwithJsonNumberEnumConverter(no Newtonsoft.Json)[JsonPropertyName("validityPeriode")]serialization quirkIWebSmsApiClient→WebSmsApiConnectionHandler→ singleMessagingConnectorarchitectureWebsms_AccessToken/Websms_RecipientAddressListenv varsTest plan
CLAUDE.mdfor accuracy against the codebaseai_instructions.mdfor accuracy and completeness.gitignorechange is correct (.ai-context/on its own line)Closes #1
🤖 Generated with Claude Code