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.

Sign up for GitHub

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

Jump to bottom

Doc: Simplify the "Decryption" doc #497

Open
yuxizama opened this issue Sep 2, 2024 · 1 comment
Open

Doc: Simplify the "Decryption" doc #497

yuxizama opened this issue Sep 2, 2024 · 1 comment
Assignees
@poppyseedDev
Labels
documentation Improvements or additions to documentation

Comments

@yuxizama
Copy link
Contributor

yuxizama commented Sep 2, 2024

Hi team,
During my review of documentation, I found the "Decryption" doc is particularly long and hard to read. I would suggest simply this document to improve readability for users. For example:

  • Add section breaks
  • Separate "function/steps explanations" and "parameter explanations", using bullet points instead of paragraphs
    Happy to provide further assistance if needed. 🙌
    Thank you!
@poppyseedDev poppyseedDev added the documentation Improvements or additions to documentation label Oct 9, 2024
@poppyseedDev
Copy link
Contributor

Agree, thanks for creating the issue @yuxizama !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@poppyseedDev poppyseedDev

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@immortal-tofu @poppyseedDev @yuxizama