Skip to content

docs: apply formatting pipeline to about-hyperswitch documentation#160

Open
atulp-hyperswitch wants to merge 1 commit intomainfrom
docs/reformat-about-hyperswitch-pipeline
Open

docs: apply formatting pipeline to about-hyperswitch documentation#160
atulp-hyperswitch wants to merge 1 commit intomainfrom
docs/reformat-about-hyperswitch-pipeline

Conversation

@atulp-hyperswitch
Copy link
Copy Markdown
Collaborator

Summary

This PR applies the documentation formatting pipeline to all markdown files in the about-hyperswitch directory.

Changes Made

Pipeline Applied (6 Steps):

  1. Frontmatter - Verified YAML frontmatter with description field for all files
  2. Headings - Enforced H1→H2→H3 hierarchy (converted H4/H5/H6 to H3)
  3. Formatting - Standardized list markers, cleaned up whitespace
  4. Brand Name - Applied Juspay Hyperswitch brand rules (full name on first mention)
  5. Stats - Verified canonical product stats
  6. Integrity - Confirmed no content was lost or duplicated

Files Modified (33 total):

Category Count Files
Roadmap 11 roadmap-q4-2024.md, roadmap-q4-2023.md, roadmap-q3-2024.md, roadmap-q2-2025.md, roadmap-q1-2024.md, roadmap-q1-2025.md, previous-roadmap-q3-2025.md, previous-roadmap-q4-2025.md, roadmap-q2-2024.md, roadmap/README.md, payment-suite.md
Payment Suite 16 Various files in payment-suite-1/ directory
AI Resources 2 ai-resources/README.md, setup-mcp-server.md
READMEs 4 Various README.md files

Verification

  • All 33 files processed successfully
  • No content lost (verified via integrity check)
  • Heading hierarchy consistent across all files
  • Brand naming rules applied consistently

Related

This follows the documentation standards established in previous formatting PRs.

Applied the documentation formatting pipeline to 33 markdown files:

- Frontmatter: Verified YAML frontmatter with description field
- Headings: Enforced H1→H2→H3 hierarchy (converted H4/H5/H6 to H3)
- Formatting: Standardized list markers, cleaned whitespace
- Brand name: Applied Juspay Hyperswitch brand rules
- Stats: Verified canonical product stats
- Integrity: Confirmed no content was lost

Files modified:
- 11 roadmap files
- 16 payment suite files
- 2 AI resources files
- 4 README files
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