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

Improve documentation of Eruption #169

Open
X3n0m0rph59 opened this issue Oct 4, 2022 · 2 comments
Open

Improve documentation of Eruption #169

X3n0m0rph59 opened this issue Oct 4, 2022 · 2 comments
Assignees
@X3n0m0rph59
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@X3n0m0rph59
Copy link
Member

X3n0m0rph59 commented Oct 4, 2022 •
edited
Loading

Improve the documentation of Eruption

The following parts of the documentation could really need some improvement:

Contributions are always welcome! For further reading on how to contribute to Eruption please refer to CONTRIBUTING.md
@X3n0m0rph59 X3n0m0rph59 added enhancement New feature or request good first issue Good for newcomers labels Oct 4, 2022
@X3n0m0rph59 X3n0m0rph59 self-assigned this Oct 4, 2022
@X3n0m0rph59 X3n0m0rph59 pinned this issue Oct 4, 2022
@X3n0m0rph59 X3n0m0rph59 added the help wanted Extra attention is needed label Oct 4, 2022
@R1yuu
Copy link
Contributor

R1yuu commented Oct 8, 2022

Is this only about the CLI or also the GUI?

@X3n0m0rph59
Copy link
Member Author

Hi @R1yuu, the Eruption GUI is currently lacking many features. I guess there won't be much to write about at this point in time... But regarding the Eruption GUI, we could use some screenshots for the image gallery on the project's homepage.

I think that the most common use-cases should be documented the best. So the top priority would definitely be to improve the HOWTOs!

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

@X3n0m0rph59 X3n0m0rph59

Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@X3n0m0rph59 @R1yuu