Skip to content

docs: v0.1.0#27

Merged
krakenhavoc merged 2 commits intomainfrom
docs/update-for-v010
Mar 27, 2026
Merged

docs: v0.1.0#27
krakenhavoc merged 2 commits intomainfrom
docs/update-for-v010

Conversation

@krakenhavoc
Copy link
Copy Markdown
Contributor

@krakenhavoc krakenhavoc commented Mar 27, 2026

This pull request introduces comprehensive documentation and onboarding improvements to the KrakenKey app repository. It adds a new top-level README.md that details the architecture, setup instructions, and related resources for the project, and it significantly expands backend documentation, especially around billing, subscriptions, and certificate issuance flows. Additionally, it updates the backend's own README to reflect new API modules and improves documentation references.

Major documentation additions and improvements:

General project documentation:

  • Added a new top-level README.md describing the overall architecture (backend, frontend, shared types), setup instructions (both devcontainer and manual), environment variables, scripts for backend/frontend, API docs, and related repositories.

Backend module and API documentation:

  • Updated backend/README.md to list new API modules (billing, organizations, endpoints, health, metrics, notifications, feedback, throttler) and improved documentation links/descriptions for easier navigation.

Billing and subscription documentation:

  • Added backend/docs/BILLING.md with detailed explanations of plan tiers, resource limits, Stripe integration, API endpoints for billing actions, subscription lifecycle, organization billing, and the subscription entity schema.

Certificate issuance flow documentation:

  • Added backend/docs/CERTIFICATE_FLOW.md covering the end-to-end process for certificate requests, including CSR generation, domain verification, ACME issuance, auto-renewal, revocation, retrying failed certificates, and plan-based quotas.

@krakenhavoc krakenhavoc merged commit 4005903 into main Mar 27, 2026
10 checks passed
@krakenhavoc krakenhavoc deleted the docs/update-for-v010 branch March 27, 2026 18:22
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