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

[Feature request] Documentation improvement #3483

Open
mdziczkowski opened this issue Sep 26, 2024 · 2 comments
Open

[Feature request] Documentation improvement #3483

mdziczkowski opened this issue Sep 26, 2024 · 2 comments

Comments

@mdziczkowski
Copy link

Hey and thanks for the great work you do with the development. It's very much appreciated because it makes the daily work much easier 🤝👍🙂

I would like to also ask by the way (whenever anyone finds some free time) to improve and update the documentation by making it in a more "user friendly" format. Please also expand the "plugins" section, with would show (with examples) how to use them in micro.

Currently, the documentation update seem to have a low priority, thru with many functions are described there more in a "general" way, without going in some places into the details, with doesn't make things easier for the users.

Additionally, the most of the documentation is beeing avaliable only online, instead of beeing included to each release, with can be a problem for those who doesn't have a stable internet connection.

This would make the configuration and usage more easier.

@JoeKar
Copy link
Collaborator

JoeKar commented Sep 26, 2024

[...] improve and update the documentation by making it in a more "user friendly" format [...] many functions are described there more in a "general" way, without going in some places into the details, with doesn't make things easier for the users.

Maybe you can give some concrete feedback what should be more detailed. This helps the maintainers and community too to respect your request.

Please also expand the "plugins" section, with would show (with examples) how to use them in micro.

So more examples?
See:

Additionally, the most of the documentation is beeing avaliable only online, instead of beeing included to each release, with can be a problem for those who doesn't have a stable internet connection.

See my answer here.

@mdziczkowski
Copy link
Author

Unfortunatelly, the plugins focus mainly on installation and not usage. Additionally, not every onewho uses micro need to either be programmer nor know the language in with the plugins are wroten.

As for the feedback, I had noticed that not every option is either docummented and if it is then the description is very brief and doesn't list possible values for it

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

No branches or pull requests

2 participants