Skip to content

docs(developer): update links to lexical model distribution #15974

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

Open
mcdurdin wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −3
Open

docs(developer): update links to lexical model distribution #15974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions developer/docs/help/guides/lexical-models/distribute/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,19 @@ welcome.htm
is also the entry point for help when accessed via Keyman's help
system or Keyman Configuration.

## Step 1) Share the lexical model package file
## Sharing the lexical model through Keyman Cloud

Follow the [Keyman Cloud Lexical Models Repository guide](/developer/lexical-models) for
instructions on how to make your lexical model available through Keyman Cloud,
where it will become seamlessly available to all users of Keyman.

## Sharing the lexical model through other channels

Using Keyman Cloud is the recommended and simplest model of distribution, as it
is generally seamless for end users. However, it is also possible to distribute
a lexical model package through other mechanisms:

### Step 1) Share the lexical model package file

Once the lexical model package .kmp file is created, you can share them
Copy link
Copy Markdown
Contributor

@ermshiperete ermshiperete May 20, 2026

Choose a reason for hiding this comment

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

It might be better to use .model.kmp instead of just .kmp when we refer to a lexical model package.

via external storage devices (USB drive, SD card, etc). If that is not
Expand All @@ -45,7 +57,7 @@ this example, the lexical model package for SENĆOŦEN is being uploaded:

1. nrc.str.sencoten.model.kmp (the lexical model package .kmp file)

## Step 2) Create a link to the KMP file
### Step 2) Create a link to the KMP file
Copy link
Copy Markdown
Contributor

@ermshiperete ermshiperete May 20, 2026

Choose a reason for hiding this comment

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

Suggested change
### Step 2) Create a link to the KMP file
### Step 2) Create a link to the lexical model KMP file


Once all the files have been uploaded, you will need to provide a link
to the lexical model package .kmp file for your device to download and
Expand Down
2 changes: 1 addition & 1 deletion developer/docs/help/guides/lexical-models/distribute/tutorial/step-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ documentation is accessible to the end user.

Once you have tested the package to your satisfaction, it is time to
distribute it. We recommend submitting your lexical model package to the
[Keyman Lexical Models Repository](https://github.com/keymanapp/lexical-models)
[Keyman Lexical Models Repository](/developer/lexical-models)

## Distributing a package on your own website

Expand Down
Loading