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 current documentation #36

Open

8 tasks done

narnaud opened this issue Jun 19, 2024 · 1 comment

Assignees

Labels

📖 documentation ❔ help wanted

Milestone

Member

narnaud commented Jun 19, 2024 •

edited

Loading

There is a lot to do to improve the current documentation:

check the install doc now that it's on github
make a tour of the GUI
better document the CLI
explain how to create a non-GUI script
explain how to create a GUI script
explain how to do script testing
dive into the TreeSitter
create a small tutorial

narnaud added 📖 documentation ❔ help wanted labels

narnaud self-assigned this

narnaud added this to the Release 1.0.0 milestone

Member Author

narnaud commented Mar 10, 2025

Everything has not been done for the documentation (like small tutorial), but it's good enough for now and the number of users...

narnaud pushed a commit to narnaud/knut that referenced this issue


          docs: Last pass on the README

920faa5

:
Fix KDAB#36

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