Skip to content

Conversation

@tl-Roberto-Mancinelli
Copy link
Collaborator

@tl-Roberto-Mancinelli tl-Roberto-Mancinelli commented Nov 5, 2025

Summary

This PR sets up comprehensive DocFX documentation for the TrueLayer .NET SDK, including:

  • Complete documentation structure with articles covering:
    • Installation and authentication
    • Payments, payouts, and mandates
    • Provider management and merchant accounts
    • Error handling and configuration
  • GitHub Actions workflow for automatic deployment to GitHub Pages
  • Custom styling with TrueLayer branding
  • API reference documentation generation from XML comments

Documentation Structure

  • Getting Started: Installation, authentication, error handling
  • Core Features: Payments, payouts, mandates, providers, merchant accounts
  • Advanced Topics: Multiple clients, custom configuration
  • API Reference: Complete API documentation from code

Key Improvements

  • Aligned status terminology with official TrueLayer documentation
  • Added references to the MVC Example throughout
  • Used proper constants (e.g., ReleaseChannels.GeneralAvailability)
  • Server-side filtering examples for providers
  • Comprehensive error handling examples

Preview Documentation Locally

To preview the documentation changes locally:

  • Restore dotnet tools dotnet tool restore
  • Build the documentation dotnet docfx docs/docfx.json
  • Serve the documentation locally dotnet docfx serve docs/_site

Then open your browser to http://localhost:8080 to view the documentation.

tl-security-scanner[bot]

This comment was marked as duplicate.

tl-security-scanner[bot]

This comment was marked as duplicate.

tl-security-scanner[bot]

This comment was marked as duplicate.

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants