docs: Reformat documentation with heading hierarchy and Juspay Hyperswitch branding#1
Open
atulp-hyperswitch wants to merge 2 commits intomainfrom
Open
docs: Reformat documentation with heading hierarchy and Juspay Hyperswitch branding#1atulp-hyperswitch wants to merge 2 commits intomainfrom
atulp-hyperswitch wants to merge 2 commits intomainfrom
Conversation
added 2 commits
March 23, 2026 13:36
…ms.txt generation Add description metadata to markdown files to support llms.txt generation: - Extracted first meaningful paragraph from each file - Added description field to frontmatter where missing - Updated 174+ markdown files across the documentation - Supports better indexing and searchability for LLMs
…nd Juspay Hyperswitch branding Apply documentation formatting rules: - Rule 1: Fix heading hierarchy (single H1, proper H2/H3 structure) - Rule 2: Add Juspay Hyperswitch branding to identity-establishing contexts - Rule 7: Add proper frontmatter descriptions (15-30 words, action verb format) Files updated: - reconciliation/README.md - reconciliation/getting-started-with-recon.md - ai-powered-cost-observability/README.md - ai-powered-cost-observability/uploading-fee-reports-for-analysis.md - revenue-recovery.md - reconciliation-product/README.md - reconciliation-product/example-e-commerce.md - reconciliation-product/how-reconciliation-works.md - reconciliation-product/roadmap.md - reconciliation-product/statuses-in-reconciliation.md
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.
Summary
This PR reformats 10 documentation files to improve consistency, clarity, and branding according to GitBook documentation standards.
Changes Applied
Rule 1 - Heading Hierarchy
Rule 2 - Brand Name: "Juspay Hyperswitch"
Rule 7 - Frontmatter Description
Files Updated
reconciliation/README.mdreconciliation/getting-started-with-recon.mdai-powered-cost-observability/README.mdai-powered-cost-observability/uploading-fee-reports-for-analysis.mdrevenue-recovery.mdreconciliation-product/README.mdreconciliation-product/example-e-commerce.mdreconciliation-product/how-reconciliation-works.mdreconciliation-product/roadmap.mdreconciliation-product/statuses-in-reconciliation.mdTesting