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

docs: Import Keyman Developer tutorials from Notion #1542

Open
darcywong00 opened this issue Sep 12, 2024 · 3 comments
Open

docs: Import Keyman Developer tutorials from Notion #1542

darcywong00 opened this issue Sep 12, 2024 · 3 comments
Labels
Milestone

Comments

@darcywong00
Copy link
Contributor

@sku21 spent an internship revamping the keyboard development guides.

The content at
https://www.notion.so/ltuse/Keyman-Developer-General-Tutorial-fb2b0b67f9014a66ae4e4b5b00a6198e

just needs to get exported to Markdown and incorporated in the guides here.

@darcywong00 darcywong00 added good first issue Good for newcomers docs labels Sep 12, 2024
@mcdurdin
Copy link
Member

Sadly, she ran out of time to complete the tutorial. We need to invest in finishing the tutorial first, before attempting to merge with content here. Once it is complete, I would like to deprecate and/or remove the existing tutorials, because I think what @sku21 has produced so far is going to be far more comprehensive and approachable than the outdated content we have here. But, all that to say, this needs to go on hold until the content is complete in Notion.

(FWIW, see also keymanapp/keyman#12347 which means that the content will be merged into the keymanapp/keyman repo, not this one, when it does eventually land)

@mcdurdin mcdurdin added this to the Future milestone Sep 26, 2024
@mcdurdin mcdurdin added this to Keyman Nov 25, 2024
@mcdurdin
Copy link
Member

mcdurdin commented Nov 28, 2024

Per FV team (@caforbes, @HopsAndHops, @xyzhelen) feedback:

The Keyman Developer Documentation was difficult to reference. Most of the
documentation is either for beginner users who will not be going into the code tab, or for
people who know the program and Keyman’s language like the back of their hand. There
is not much that helps a user bridge that gap. Or maybe part of the problem was in
difficulties navigating the documentation and finding the correct page, etc.
o It would be helpful if there were simple tutorials or explainers on the different
files in a project, what they’re for, and/or where to edit them, for example.

and ...

I’ve attached a guide that we cobbled together internally – parts are specific to our
workflow, but it might show the kind of information that we were looking for
(mid-intermediate Keyman knowledge, no development background).

Copied to our Google drive (not public): https://drive.google.com/file/d/1-8QYkB_d8zeuJTVsNWQLQU0FurRn2paR/view?usp=drive_link

and ...

Add more information about all of the help and info files. Explain what does what, and
what info is pulling from where

  • What does the help.htm do? It took more investigating that necessary to determine
    that this is for Web-Help, and so in our case is redundant since the base help is
    used on that page.
  • This specifically is not addressed in existing Keyman Developer tutorials – we
    were really confused about the help files.

@mcdurdin mcdurdin removed the good first issue Good for newcomers label Dec 6, 2024
@mcdurdin
Copy link
Member

mcdurdin commented Dec 6, 2024

Note: I think 'good first issue' is a bit ambitious given how much content is left to complete. Needs a deep understanding of the keyboard + model development process!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

2 participants