Skip to content

docs: Add comprehensive SDK documentation and README improvements#10

Merged
dasiths merged 4 commits into
mainfrom
feat/gap-remediation-plan-updates
May 22, 2026
Merged

docs: Add comprehensive SDK documentation and README improvements#10
dasiths merged 4 commits into
mainfrom
feat/gap-remediation-plan-updates

Conversation

@dasiths
Copy link
Copy Markdown
Collaborator

@dasiths dasiths commented May 22, 2026

Summary

Adds complete SDK documentation (22 markdown files) covering all AAuth .NET SDK workflows and signing modes, plus README improvements.

Documentation (docs/)

  • Foundation: Index, getting started, protocol concepts (four participants: Agent, Resource, PS, AS)
  • Signing Modes: Overview + individual guides for hwk, jwks_uri, jwt, jkt-jwt
  • Workflows: Identity-based, resource-managed, PS-asserted, federated, bootstrap/enrollment, deferred consent
  • Server Implementation: Verification middleware, resource metadata, token issuance, replay detection, multi-scheme verification
  • Advanced: Missions, platform attestation, key management, error handling
  • Reference: Full configuration options for all SDK components

All docs link to the AAuth Explorer as the golden reference.

README Changes

  • Renamed project to AAuth SDK for .NET
  • Added 🚧 draft-spec notice at the top
  • Removed outdated WIP/Phase 3 status banner
  • Moved per-sample running instructions to samples/README.md
  • Consolidated repository layout table
  • Corrected the four protocol participants (Agent, Resource, PS, AS — AP is a supporting role)

Prior Implementation (included in branch)

This branch also includes the gap remediation implementation work:

  • All four signing modes end-to-end (hwk, jwks_uri, jwt, jkt-jwt)
  • Spec-compliant error model (supported_algorithms on unsupported_algorithm errors)
  • MockAgentProvider sample
  • Demo mode constraints (jwt requires PS, identity uses hwk/jwks_uri)
  • Verification hardening and extensibility seams

All 320 tests pass (130 unit + 190 conformance).

dasiths added 4 commits May 22, 2026 16:04
Extract the detailed per-sample running instructions from the root
README into samples/README.md. Root README now has a short 'make demo'
quick-start with a link to the full guide. Also consolidates the
repository layout table to a single samples/ entry.
@dasiths dasiths merged commit 7b3adb2 into main May 22, 2026
@dasiths dasiths deleted the feat/gap-remediation-plan-updates branch May 22, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant