chore(docs): PR 1.6 add documentation and linting configuration for v3 #361
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.
📝 Checklist
🔧 Changes
This PR adds comprehensive documentation and linting configuration for v3:
Documentation Added:
doc.gopackage documentation for all packages:core/doc.go: Core-Adapter pattern, context helpersvalidator/doc.go: JWT validation with jwx v3, supported algorithmsjwks/doc.go: JWKS provider configuration and cachinginternal/oidc/doc.go: OIDC discovery endpointsDocumentation Updated:
README.md: Complete v3 API documentationMIGRATION_GUIDE.md: Complete v2 to v3 migration guideLinting Configuration:
.golangci.yml: golangci-lint v2.6.2 configuration.github/workflows/lint.yaml: Updated to use golangci-lint-action v9.1.0 with v2.6.2Makefile: Added golangci-lint v2.6.2 installation targetCode Cleanup:
validator/security.goandvalidator/security_test.goTypes/Functions Changed:
📚 References
🔬 Testing
Test Coverage:
Linting:
Manual Testing:
Verification: