feat(docs): added AGENTS.md for AI Agent #90
Merged
Conversation
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
Reviewer's GuideIntroduces a new AGENTS.md file that serves as an end-to-end developer guide for the xun frameworkβs AI Agent features, covering core concepts, setup, routing, viewers, templating, assets, extensions, and best practices. Class diagram for core xun framework types (from AGENTS.md)classDiagram
class App {
+ServeMux
+routes
+globalMiddlewares
+viewEngines
+viewers
+compressors
+templateFuncMap
+assetURLMap
+Start()
+Close()
+Get()
+Group()
+Use()
}
class Context {
+Request
+Response
+Routing
+App
+TempData
+View()
+Redirect()
+Accept()
+AcceptLanguage()
+Get()
+Set()
}
class Viewer {
+MimeType
+Render()
}
class ViewEngine {
+Load()
+FileChanged()
}
class ResponseWriter {
+http.ResponseWriter
+status
+bodyBytes
+Close()
}
App "1" -- "*" Context : creates
App "1" -- "*" ViewEngine : uses
App "1" -- "*" Viewer : uses
App "1" -- "*" ResponseWriter : wraps
Context "1" -- "1" App : belongs to
Context "1" -- "1" ResponseWriter : wraps
Viewer <|-- HtmlViewer
Viewer <|-- JsonViewer
Viewer <|-- TextViewer
Viewer <|-- XmlViewer
Viewer <|-- StringViewer
Viewer <|-- FileViewer
ViewEngine <|-- HtmlViewEngine
ViewEngine <|-- TextViewEngine
ViewEngine <|-- StaticViewEngine
Class diagram for extension modules (ext/*) overviewclassDiagram
class ACL {
+filterByHost()
+filterByIP()
+filterByCIDR()
+filterByCountry()
+redirect()
+hotReloadConfig()
}
class AutoTLS {
+manageCertificates()
+renewCertificates()
}
class Cache {
+cacheHelpers()
}
class Cookie {
+base64Cookies()
+signedCookies()
}
class CSRF {
+csrfProtection()
+jsToken()
}
class Form {
+BindQuery[T]()
+BindForm[T]()
+BindJson[T]()
+Validate()
}
class HSTS {
+enforceHSTS()
+redirectHTTP()
}
class HTMX {
+integrationHelpers()
+interceptor()
}
class ProxyProto {
+supportV1()
+supportV2()
}
class ReqLog {
+accessLogMiddleware()
}
class SSE {
+sessions()
+push()
+broadcast()
+shutdown()
}
App "1" -- "*" ACL : uses
App "1" -- "*" AutoTLS : uses
App "1" -- "*" Cache : uses
App "1" -- "*" Cookie : uses
App "1" -- "*" CSRF : uses
App "1" -- "*" Form : uses
App "1" -- "*" HSTS : uses
App "1" -- "*" HTMX : uses
App "1" -- "*" ProxyProto : uses
App "1" -- "*" ReqLog : uses
App "1" -- "*" SSE : uses
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Here's the code health analysis summary for commits Analysis Summary
|
Codecov Reportβ
All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #90 +/- ##
=======================================
Coverage 91.70% 91.70%
=======================================
Files 66 66
Lines 2676 2676
=======================================
Hits 2454 2454
Misses 192 192
Partials 30 30
Flags with carried forward coverage won't be shown. Click here to find out more. β View full report in Codecov by Sentry. π New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Changed
Fixed
Added
Tests
Tasks to complete before merging PR:
make unit-teststo check for any regressions πmake lintto check for any issues