Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: Add some docs! #15

Open
popey opened this issue May 15, 2024 · 2 comments
Open

feat: Add some docs! #15

popey opened this issue May 15, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@popey
Copy link
Contributor

popey commented May 15, 2024

What would you like to be added:

Some documentation.

Why is this needed:

There's a lot of comments in the code, explaining what the various parameters do, and how they work. But there should be some docs which are more user accessible.

I think we should start with a wiki to get the information out of the script (and my head) and into the repo initially.

Perhaps a if this gets all big and complex we start a static site containing docs generated from the repo, or readthedocs. I don't have strong opinions here.

Additional context:

Some ideas for documents

  • How to install quicktest, covering the deb, and from source
  • How to run existing tests in quicktest
    • Interactively
    • Headless
  • How to write tests
    • Gathering screenshots and text
    • Writing the test itself
  • How to debug tests
  • Maybe an FAQ (although I personally don't like FAQs, as they generally mean the documentation is missing something)
@popey popey added the enhancement New feature or request label May 15, 2024
@popey popey self-assigned this May 15, 2024
@popey
Copy link
Contributor Author

popey commented May 15, 2024

Brain dump is the next step!

@popey
Copy link
Contributor Author

popey commented May 15, 2024

A start has been made.

Feel free to use this issue to suggest further documents which may be useful!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant