Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces comprehensive documentation and onboarding improvements to the KrakenKey app repository. It adds a new top-level
README.mdthat 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:
README.mddescribing 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:
backend/README.mdto list new API modules (billing, organizations, endpoints, health, metrics, notifications, feedback, throttler) and improved documentation links/descriptions for easier navigation.Billing and subscription documentation:
backend/docs/BILLING.mdwith 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:
backend/docs/CERTIFICATE_FLOW.mdcovering 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.