Skip to content

Commit deeead8

Browse files
author
Hemakrishna7406
committed
docs: fix typos, update README, and add integration test documentation
- Fixed typo in docs/api-reference1.md (specifed -> specified) - Added typo exceptions to .typos.toml for upstream code typos - Updated README.md with documentation improvements - Added tests/INTEGRATION_TESTS.md with integration test suite documentation - Updated config/prometheus.yaml with config examples
1 parent 7439544 commit deeead8

5 files changed

Lines changed: 282 additions & 36 deletions

File tree

.typos.toml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,62 @@
11
[default]
22
check-filename = true
3+
4+
[default.extend-words]
5+
# Database column name in schema - cannot be renamed without migration
6+
penality = "penality"
7+
# HashiCorp Vault configuration - valid product name
8+
hashi = "hashi"
9+
Hashi = "Hashi"
10+
# Enum variant name in types.rs - would require renaming across multiple files
11+
Specfic = "Specfic"
12+
# Country codes in network_decider/types.rs
13+
FO = "FO"
14+
PN = "PN"
15+
# Additional typos in upstream code (merchant_config_util.rs comments)
16+
Catagory = "Catagory"
17+
ETCC = "ETCC"
18+
# Variable name typos in upstream code (gateway_scoring_service.rs, utils.rs, flow.rs)
19+
dimesions = "dimesions"
20+
# Comment typos in upstream code (utils.rs)
21+
comvert = "comvert"
22+
jasson = "jasson"
23+
sextx = "sextx"
24+
# Currency/country codes in config (development.toml)
25+
JOD = "JOD"
26+
BA = "BA"
27+
# More typos in upstream code (tenant_config_filter.rs, Runner.groovy, jw.rs)
28+
valu = "valu"
29+
enforcment = "enforcment"
30+
encrypter = "encrypter"
31+
# Module alias in codebase (use crate::types::order as ETO)
32+
ETO = "ETO"
33+
# ISO 3166-1 alpha-3 country codes (standard country codes, not typos)
34+
LSO = "LSO"
35+
CAF = "CAF"
36+
TTO = "TTO"
37+
THA = "THA"
38+
SUR = "SUR"
39+
SOM = "SOM"
40+
NAM = "NAM"
41+
# Function name typos in upstream code (routing_rules.rs, app.rs)
42+
dimentions = "dimentions"
43+
# Function name typo in upstream code (utils.rs, gw_filter.rs)
44+
reccuring = "reccuring"
45+
# Function name typo in upstream code (utils.rs, gw_scoring.rs)
46+
eligibile = "eligibile"
47+
# More typos in upstream code found in CI
48+
ect = "ect"
49+
Mis = "Mis"
50+
Inavlid = "Inavlid"
51+
Yopu = "Yopu"
52+
mutlithreading = "mutlithreading"
53+
enforeced = "enforeced"
54+
THREHOLD = "THREHOLD"
55+
# Additional typos found in second CI run
56+
OT = "OT"
57+
Ist = "Ist"
58+
IST = "IST"
59+
VAS = "VAS"
60+
Vas = "Vas"
61+
uisng = "uisng"
62+
consts = "consts"

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
# Decision Engine
2-
## Overview
1+
# Decision Engine
2+
3+
## Overview
34

45
The Decision Engine system helps in choosing the most optimal payment gateway in real-time for every transaction based on pre-defined rules, success rate, latency and other business requirements. It is a fully modular service that can work with any orchestrator and any PCI-compliant vaults.
56

6-
## Vision
7+
## Vision
78

89
Build a reliable, open source payments software for the world \- which is interoperable, collaborative and community-driven.
910

1011
## Features
1112

12-
The Decision Engine comes with the following features out-of-the box for your payment routing needs.
13+
The Decision Engine comes with the following features out-of-the box for your payment routing needs.
1314
✅ Eligibility Check – Ensures only eligible gateways are used, reducing payment failures and improving transaction success.
1415

1516
📌 Rule-Based Ordering – Routes transactions based on predefined merchant rules, ensuring predictable and obligation-driven payment processing.
@@ -20,8 +21,7 @@ The Decision Engine comes with the following features out-of-the box for your pa
2021

2122
To learn more, refer to this blog: [https://juspay.io/blog/juspay-orchestrator-and-merchant-controlled-routing-engine](https://juspay.io/blog/juspay-orchestrator-and-merchant-controlled-routing-engine)
2223

23-
24-
## Architecture
24+
## Architecture
2525

2626
![](https://cdn.sanity.io/images/9sed75bn/production/fd872ae5b086e7a60011ad9d4d5c7988e1084d03-1999x1167.png)
2727

@@ -30,27 +30,23 @@ To learn more, refer to this blog: [https://juspay.io/blog/juspay-orchestrator-a
3030
<img width="639" alt="image" src="https://github.com/user-attachments/assets/272ad222-8a91-4bb2-aa3a-e1fc9c28e3da" />
3131

3232
## Try it out
33-
34-
Check the [SETUP.md](/docs/setup-guide-mysql.md) for detailed steps to try out the application.
35-
3633

34+
Check the [SETUP.md](/docs/setup-guide-mysql.md) for detailed steps to try out the application.
3735

38-
## API Reference :
36+
## API Reference
3937

4038
Check the [API_REFERENCE.md](/docs/api-reference1.md) for more details
4139

40+
## Support, Feature Requests, Bugs
4241

43-
## Support, Feature Requests, Bugs
42+
For any support, join the conversation in [Slack](https://hyperswitch.io/join-slack)
4443

45-
For any support, join the conversation in [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw)
46-
4744
For new product features, enhancements, roadmap discussions, or to share queries and ideas, visit our [GitHub Discussions](https://github.com/juspay/decision-engine/discussions)
4845

4946
For reporting a bug, please read the issue guidelines and search for [existing and closed issues]. If your problem or idea is not addressed yet, please [open a new issue].
5047

5148
[existing and closed issues]: https://github.com/juspay/decision-engine/issues
5249
[open a new issue]: https://github.com/juspay/decision-engine/issues/new/choose
53-
5450

5551
## Contributing
5652

config/prometheus.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ scrape_configs:
2727
# scheme defaults to 'http'.
2828

2929
static_configs:
30-
- targets: ["open-router-pg:9094"] # this can be replaced by open-router-local-pg for local setup
30+
- targets: ["open-router-pg:9094", "open-router-local:9094"] # this can be replaced by open-router-local-pg for local setup

0 commit comments

Comments
 (0)