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 when phase refactoring #977

Open
matteo-cristino opened this issue Nov 22, 2024 · 2 comments
Open

Docs when phase refactoring #977

matteo-cristino opened this issue Nov 22, 2024 · 2 comments
Labels
discussion topic under discussion and collective analysis documentation issue related to documentation

Comments

@matteo-cristino
Copy link
Collaborator

I think that now zencode "basic" (without taking into consideration the scenarios) When phase contains a lot of statements and the documentation is getting a bit chaotic in particular for this phase, for example the manipulation chapter contains a lot of examples, making it harder for the user to find the correct chapter in which he/she can learn what he/she needs and for us to matain it, since we do not know what we have in there.

I would propose to divide them a bit more into specific subsections, the first that comes to minds are

  • random
  • numbers (operations and comparison)
  • time (how they works, pros and limitations)
  • copy and move
  • string operations (write, append, split)
  • table operations (works for both array and dictionaries)
  • array operations
  • dictionary operations
  • hash (hash, kdf, pbkdf, hmac)

each of this should have short and concise examples to get the user to understand them as simply as possible and maybe get him/her to try them.

Let me know if this makes sense to you 💭

@matteo-cristino matteo-cristino added documentation issue related to documentation discussion topic under discussion and collective analysis labels Nov 22, 2024
@jaromil
Copy link
Member

jaromil commented Nov 25, 2024

This totally makes sense, I also find it hard to navigate!

@matteo-cristino
Copy link
Collaborator Author

If anyone want to help I started a new branch for this: docs/when_refactor in which, at the moment, I am more organizing the ideas and adding some first chapters. It is still very rough, but will improve quickly I hope 🌞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion topic under discussion and collective analysis documentation issue related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants