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

docs: Add documentation for non-interactive safe-cli commands #571

Merged
merged 5 commits into from
Sep 11, 2024

Conversation

falvaradorodriguez
Copy link
Contributor

@falvaradorodriguez falvaradorodriguez commented Aug 23, 2024

Closes safe-global/safe-cli#434

To be considered:

  • The demos and guides sections have been unified to follow the same format as in other documentation sections. Each demo has been integrated as a new guide.
  • Added documentation of the new command options in safe-cli.

Copy link

github-actions bot commented Aug 23, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Aug 23, 2024

Overall readability score: 53.57 (🟢 +0.09)

File Readability
common-commands.mdx 82.47 (🟢 +0.48)
unattended-commands.mdx 61.68 (-)
faq.md 46.96 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
common-commands.mdx 82.47 68.16 6.48 7.9 8.97 6.3
  🟢 +0.48 🟢 +0 🟢 +0.05 🟢 +0.1 🟢 +0.06 🟢 +0.05
unattended-commands.mdx 61.68 48.5 9.85 10.7 11.71 7.49
  - - - - - -
faq.md 46.96 50.06 13.07 14.3 12.59 8.42
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.57 47 11.07 13.07 12.76 7.76
  🟢 +0.09 🟢 +0.02 🟢 +0.02 🟢 +0.03 🟢 +0.01 🟢 +0
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

@falvaradorodriguez falvaradorodriguez self-assigned this Aug 23, 2024
@falvaradorodriguez falvaradorodriguez marked this pull request as ready for review August 23, 2024 12:17
@tanay1337 tanay1337 requested review from valle-xyz and removed request for tanay1337 and louis-md August 26, 2024 07:52
@valle-xyz
Copy link
Collaborator

This PR works, but I have some remarks:

  • Three new guides are links to videos without sound. I don't find this optimal. The guides should be written guides, and the videos should be accompanied.
  • The reference is complete, but the design can be improved.
  • We could even consider adding each command in its own sidebar link, as with the Api Kit Reference.

I am unsure what to do here, so I will ask @tanay1337 and @germartinez. I would say we can accept this PR and open a ticket for ourselves to improve the quality of these docs.

@falvaradorodriguez
Copy link
Contributor Author

This PR works, but I have some remarks:

  • Three new guides are links to videos without sound. I don't find this optimal. The guides should be written guides, and the videos should be accompanied.
  • The reference is complete, but the design can be improved.
  • We could even consider adding each command in its own sidebar link, as with the Api Kit Reference.

I am unsure what to do here, so I will ask @tanay1337 and @germartinez. I would say we can accept this PR and open a ticket for ourselves to improve the quality of these docs.

Just to clarify, the guides have been moved from the "Demo" section to the "Guides" section, for share the same structure in all projects in safe-docs. But these videos already existed in the doc.

@valle-xyz
Copy link
Collaborator

Hey Felipe,

to merge this PR, we would require to either:

  • update the guides to proper (written) guides (example).
  • Or remove the guide updates from the PR

We aim for consistency in the docs regarding what a guide and what a tutorial is.

So we would ask you to fix this to speed up the review of this PR, or we would take it up in the next sprint.

@falvaradorodriguez
Copy link
Contributor Author

falvaradorodriguez commented Aug 28, 2024

Hey Felipe,

to merge this PR, we would require to either:

  • update the guides to proper (written) guides (example).
  • Or remove the guide updates from the PR

We aim for consistency in the docs regarding what a guide and what a tutorial is.

So we would ask you to fix this to speed up the review of this PR, or we would take it up in the next sprint.

Hi @valle-xyz,

Since this is not a trivial change, I have opted to revert the updating of the Demos section.

Thanks.

Copy link
Collaborator

@valle-xyz valle-xyz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added minor grammarly correction. Looks good to me.

@falvaradorodriguez falvaradorodriguez merged commit 934aec7 into main Sep 11, 2024
4 checks passed
@falvaradorodriguez falvaradorodriguez deleted the add-non-interactive-commands-safe-cli branch September 11, 2024 14:01
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.

[DOC] Adding scripting mode documentation to safe-docs
3 participants