Skip to content

epic: launch a versioned PayBridge documentation site on GitHub Pages #77

Description

@teesofttech

Outcome

Create an official, searchable, versioned documentation site hosted on GitHub Pages and linked from the repository and NuGet package.

Deliverables

  • Getting started and installation.
  • Configuration and secret-management guidance.
  • Provider capability matrix and per-gateway guides.
  • Create, verify, refund, webhook, and routing concepts.
  • Generated .NET API reference.
  • Testing, troubleshooting, migration, and contribution guides.
  • Automated Pages deployment, link checking, and preview workflow.

Acceptance criteria

  • A public Pages URL is enabled and uses HTTPS.
  • The site is deployed from a reviewed GitHub Actions workflow.
  • README, repository About, releases, and NuGet metadata link to it.
  • Search, responsive navigation, accessibility, and version indication work.
  • Documentation ownership and update policy are defined.
  • Child documentation issues are linked from this epic.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: ci/cdGitHub Actions, release automation, and deploymentarea: documentationDocumentation site, guides, and API referencedocumentationImprovements or additions to documentationepicLarge outcome split into multiple deliverable issuespriority: P1High priority; should be addressed next

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions