Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Config service configuration #682

Merged
merged 43 commits into from
Feb 3, 2025
Merged

feat: Config service configuration #682

merged 43 commits into from
Feb 3, 2025

Conversation

louis-md
Copy link
Collaborator

Adds documentation for the Config service using Django admin panel. This PR documents the different parameters available for configuration.

@louis-md louis-md requested a review from tanay1337 January 29, 2025 17:17
Copy link

github-actions bot commented Jan 29, 2025

Branch preview

✅ Deployed successfully in branch deployment:

https://api_config_parameters--docs.review.5afe.dev

Copy link

github-actions bot commented Jan 29, 2025

Overall readability score: 35.67 (🟢 +1.75)

File Readability
common-commands.mdx 82.32 (🟢 +0)
react-native.mdx 64.19 (🟢 +0)
add-or-edit-chain.mdx 86.21 (-)
add-or-edit-client.mdx 79.51 (-)
add-or-edit-feature.mdx 81.71 (-)
add-or-edit-gas-price.mdx 91.23 (-)
add-or-edit-group.mdx 81.56 (-)
add-or-edit-provider.mdx 83.03 (-)
add-or-edit-safe-app-feature.mdx 81.79 (-)
add-or-edit-safe-app.mdx 93.92 (-)
add-or-edit-social-profile.mdx 74.36 (-)
add-or-edit-tag.mdx 87.29 (-)
add-or-edit-wallet.mdx 67.36 (-)
add-user.mdx 75.4 (-)
edit-user.mdx 78.13 (-)
overview.mdx 53 (-)
safe-infrastructure-deployment.mdx 70.47 (🔴 -0.62)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
common-commands.mdx 82.32 68.16 6.48 8 8.97 6.3
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
react-native.mdx 64.19 54.52 9.96 11 10.9 7.18
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
add-or-edit-chain.mdx 86.21 70.19 6.49 6.5 8.62 6.02
  - - - - - -
add-or-edit-client.mdx 79.51 61.36 9.5 8 6.56 6.27
  - - - - - -
add-or-edit-feature.mdx 81.71 67.25 8.73 6.7 7.76 6.36
  - - - - - -
add-or-edit-gas-price.mdx 91.23 82.65 7.7 6 6 5.83
  - - - - - -
add-or-edit-group.mdx 81.56 72.87 9.4 7.2 6.95 6.47
  - - - - - -
add-or-edit-provider.mdx 83.03 65.42 8.53 7.1 7.24 6.01
  - - - - - -
add-or-edit-safe-app-feature.mdx 81.79 65.93 8.89 6.9 7.47 6.22
  - - - - - -
add-or-edit-safe-app.mdx 93.92 86.4 6.06 6 6 6.06
  - - - - - -
add-or-edit-social-profile.mdx 74.36 55.24 8.4 8.9 8.7 6.8
  - - - - - -
add-or-edit-tag.mdx 87.29 75.71 8.73 6 6 6.15
  - - - - - -
add-or-edit-wallet.mdx 67.36 58.58 10.02 9.5 10.37 7.28
  - - - - - -
add-user.mdx 75.4 59.3 8.44 6.9 8.4 7.7
  - - - - - -
edit-user.mdx 78.13 59.9 8.42 6.4 7.46 7.53
  - - - - - -
overview.mdx 53 48.4 10.12 11.7 13.33 8.88
  - - - - - -
safe-infrastructure-deployment.mdx 70.47 60.51 8.37 9 10.71 7.37
  🔴 -0.62 🔴 -0.1 🔴 -0.17 🔴 -0.1 🔴 -0.12 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 35.67 31.2 13.23 16.61 15.07 8.74
  🟢 +1.75 🟢 +1.4 🟢 +0.19 🟢 +0.37 🟢 +0.28 🟢 +0.08
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@tanay1337 tanay1337 requested review from valle-xyz and removed request for tanay1337 January 30, 2025 09:17
pages/config-service-configuration/add-or-edit-chain.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/add-or-edit-chain.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/add-or-edit-chain.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/add-or-edit-chain.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/add-or-edit-chain.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/add-or-edit-tag.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/overview.mdx Outdated Show resolved Hide resolved
pages/config-service-configuration/overview.mdx Outdated Show resolved Hide resolved
louis-md and others added 20 commits January 31, 2025 15:46
louis-md and others added 19 commits January 31, 2025 15:56
@louis-md louis-md merged commit b99e57f into main Feb 3, 2025
3 of 4 checks passed
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.

2 participants