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(ios): engine: missing InstallableKeyboard and InstallableLexicalModel documentation #1156

Open
mcdurdin opened this issue Mar 27, 2024 · 4 comments
Assignees
Labels
Milestone

Comments

@mcdurdin
Copy link
Member

https://help.keyman.com/developer/engine/iphone-and-ipad/16.0/LanguageResource/ talks about these types but they are not documented. Also, many types are either not linked up, or the links are shown as preformatted text, e.g.:

image

@mcdurdin mcdurdin added the docs label Mar 27, 2024
@mcdurdin mcdurdin added this to the B17S5 milestone Mar 27, 2024
@mcdurdin mcdurdin changed the title docs(engine/ios): missing InstallableKeyboard and InstallableLexicalModel documentation docs(ios): engine: missing InstallableKeyboard and InstallableLexicalModel documentation Mar 30, 2024
@mcdurdin
Copy link
Member Author

@sgschantz assigning you, happy to discuss on prioritization.

@darcywong00 darcywong00 modified the milestones: B17S5, B17S6 Apr 12, 2024
@jahorton jahorton self-assigned this Apr 12, 2024
@darcywong00 darcywong00 modified the milestones: B17S6, A18S1 Apr 28, 2024
@jahorton
Copy link
Contributor

jahorton commented May 9, 2024

That page's "Description" was originally intended to be the documentation for those types in addition to LanguageResource. Any documentation I can think to add would essentially be heavily-WET replications of the documentation in the linked page, just with LanguageResource more explicitly and consistently being replaced by one of its two variants. (Like, find-and-replace.) If you're fine with that, I can just go that lazy route and call it a day, I guess.

I certainly won't argue the link-issue, though.

@mcdurdin
Copy link
Member Author

mcdurdin commented May 9, 2024

heavily-WET

Does not really apply to documentation. That is, the documentation page should have enough detail in it for an end user to understand the purpose. If that means some duplication of content, so be it, it's not the end of the world.

More importantly though: each type needs its own documentation page, and it is acceptable to point to a parent class for more details.

@darcywong00 darcywong00 modified the milestones: A18S1, A18S2 May 11, 2024
@mcdurdin mcdurdin modified the milestones: A18S2, A18S3, A18S8 May 24, 2024
@darcywong00 darcywong00 modified the milestones: A18S8, A18S9 Aug 17, 2024
@darcywong00 darcywong00 modified the milestones: A18S9, A18S10 Aug 31, 2024
@darcywong00 darcywong00 modified the milestones: A18S10, A18S11 Sep 14, 2024
@sgschantz sgschantz modified the milestones: A18S11, A18S15 Sep 16, 2024
@sgschantz
Copy link
Contributor

moving to sprint focusing on ios

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants