Skip to content

docs(payment-suite-1): reformat markdown files with proper frontmatter and headings#148

Open
atulp-hyperswitch wants to merge 4 commits intomainfrom
docs/reformat-payment-suite-1
Open

docs(payment-suite-1): reformat markdown files with proper frontmatter and headings#148
atulp-hyperswitch wants to merge 4 commits intomainfrom
docs/reformat-payment-suite-1

Conversation

@atulp-hyperswitch
Copy link
Copy Markdown
Collaborator

Summary

This PR reformats 18 markdown files in the payment-suite-1 directory to follow Juspay Hyperswitch documentation standards.

Changes Made

  1. Frontmatter Updates

    • Added/updated YAML frontmatter with descriptive description fields
    • Descriptions follow the format: "[Action verb] [topic] to [reader benefit]"
    • Added icon and hidden fields where appropriate
  2. Heading Hierarchy Fixes

    • Fixed heading levels to follow proper H1→H2→H3 progression
    • Removed heading level skips (e.g., H1→H4)
    • Standardized heading capitalization and formatting
  3. Formatting Improvements

    • Fixed list formatting (converted asterisks to dashes where appropriate)
    • Corrected typos (e.g., "Documetation" → "Documentation", "merhcnat" → "merchant")
    • Removed extra blank lines in code blocks
    • Standardized code block formatting
  4. Consistency

    • Applied consistent "Hyperswitch" branding
    • Standardized link formatting
    • Improved overall readability

Files Modified

  • vault-and-forward.md
  • s2s-vault-flow.md
  • payment-method-management-sdk.md
  • payments-cards/saved-card/README.md
  • payments-cards/saved-card/save-a-payment-method.md
  • payments-cards/recurring-payments.md
  • payments-cards/manual-capture/README.md
  • payments-cards/manual-capture/overcapture.md
  • payments-cards/copy-of-subscriptions.md
  • payments/README.md
  • payment-with-vault-flow/README.md
  • payment-with-vault-flow/merchant-sdk-+-hyperswitch-vault-setup.md
  • payment-with-vault-flow/hyperswitch-sdk-+-hyperswitch-vault-setup.md
  • payment-method-card/README.md
  • payment-method-card/payments.md
  • payment-method-card/proxy.md
  • payment-method-card/payment-methods-management.md
  • payment-method-card/copy-of-payments.md

Type of Change

  • Bugfix
  • New feature
  • Documentation improvement
  • Refactoring
  • Other

Impact

  • Improves documentation consistency and readability
  • No functional changes
  • Enhances SEO with proper meta descriptions

Atul P added 4 commits March 27, 2026 16:28
…r, headings and formatting

- Add/update YAML frontmatter with descriptive descriptions
- Fix heading hierarchy (H1→H2→H3)
- Correct typos and formatting issues
- Standardize list formatting across all files
- Apply consistent Hyperswitch branding

Files modified: 18 markdown files in payment-suite-1 directory
…entions

- Replace first occurrence of 'Hyperswitch' with 'Juspay Hyperswitch' in each file
- Keep compound terms unchanged (Hyperswitch SDK, Hyperswitch Vault, etc.)
- Skip URLs, code blocks, and subsequent mentions per brand guidelines
- Add/update YAML frontmatter with descriptions to all 250 markdown files
- Fix heading hierarchy (H1→H2→H3) across 145 files
- Fix formatting (lists, tables, typos, spacing)
- Apply Juspay Hyperswitch brand name rules (capitalization)
- Update product stats to canonical values (300+ connectors, 300+ payment methods)
- Verify content integrity - no issues found
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