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

[Documentation] How to test a new keyboard guide #36

Merged
merged 14 commits into from
Jun 4, 2024

Conversation

QADavidCalvo
Copy link
Contributor

Add documentation to know how to test a new keyboard that is not supported yet by Kebbie

🔍️ Description

This documentation is mainly focused on how to set up an Android emulator and evaluate an Android keyboard.

🧐 Context

This doc should be a step by step guide to add or just test any keyboard with Kebbie

⚠️ Side-effects / Shortcomings

Maybe we can add some screenshots

✅ How this was tested ?

🌱 Checklist

  • Perform self-review of my own code
  • Comment the code, particularly in hard-to-understand areas
  • [] Update the documentation accordingly to the new code
  • Lint / format the code
  • Update existing tests / Add new tests
  • Tests are passing locally

@QADavidCalvo QADavidCalvo self-assigned this May 27, 2024
@QADavidCalvo QADavidCalvo changed the title Test new keyboard doc [Documentation] How to test a new keyboard guide May 27, 2024
@QADavidCalvo QADavidCalvo requested a review from astariul May 27, 2024 14:13
@astariul
Copy link
Collaborator

astariul commented May 28, 2024

Thanks for the PR !

Having this additional page will be very helpful.

At the moment, there are some issues with the render; how did you test your changes ? If you do :

pip install -e ".[docs]"
mkdocs serve

You should be able to visualize the page by going to http://127.0.0.1:8000/test_a_new_keyboard/

And then you can fix the rendering issues in the markdown file (like the bullet points or the admonitions)


And I agree, adding screenshots would be extra-helpful ! (Specially in the section about accessing settings)

@QADavidCalvo
Copy link
Contributor Author

Thanks for the PR !

Having this additional page will be very helpful.

At the moment, there are some issues with the render; how did you test your changes ? If you do :

pip install -e ".[docs]"
mkdocs serve

You should be able to visualize the page by going to http://127.0.0.1:8000/test_a_new_keyboard/

And then you can fix the rendering issues in the markdown file (like the bullet points or the admonitions)

And I agree, adding screenshots would be extra-helpful ! (Specially in the section about accessing settings)

I didn't know it. Thanks! I'll check it

@QADavidCalvo
Copy link
Contributor Author

Screenshots added and checked the render.

docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
@astariul astariul mentioned this pull request May 29, 2024
6 tasks
@QADavidCalvo
Copy link
Contributor Author

PR ready to re-check @astariul
Please compile it locally to check the render too.

docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
docs/test_a_new_keyboard.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@astariul astariul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ! 👍

@QADavidCalvo QADavidCalvo merged commit 05ff69d into main Jun 4, 2024
2 checks passed
@QADavidCalvo QADavidCalvo deleted the test_new_keyboard_doc branch June 4, 2024 07:48
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

Successfully merging this pull request may close these issues.

2 participants