docs(developer): Add Developer walkthrough tutorial #15447
Conversation
keymanapp-test-bot
bot
added
the
user-test-missing
User Test ResultsTest specification and instructions User tests are not required |
|
Test-bot: skip. Not sure if this is needed?! |
keymanapp-test-bot
bot
removed
the
user-test-missing
I think you edit the PR description and have at the bottom of the text area:
|
darcywong00
changed the title
darcywong00
left a comment
darcywong00
left a comment
There was a problem hiding this comment.
Thanks for the extensive work in migrating this from Notion!
Just a few initial comments for now. Some may warrant more discussion before making changes throughout.
|
|
||
| Keyman Developer is a powerful tool you can use to create custom keyboards optimized to type in any language you choose. Keyboard authors can distribute their work for desktop, web, tablet and phone, enabling global communities to quickly benefit from keyboards made for their own language. | ||
|
|
||
| Keyboards created with Keyman Developer can be used on Windows, Mac, Linux, iOS, Android, and the web. |
There was a problem hiding this comment.
I think we generally try to be consistent in using "macOS" instead of "Mac" or "MacOS". (See l.20, 32, etc)
|
|
||
| After installing Keyman Developer, you should be able to run it on your computer and begin creating projects immediately. | ||
|
|
||
| Note that Keyman Developer is a separate app from Keyman, which is the app that lets you use any keyboard created with Keyman Developer. |
There was a problem hiding this comment.
We can style "notes" like
| Note that Keyman Developer is a separate app from Keyman, which is the app that lets you use any keyboard created with Keyman Developer. | |
| > [!Note] | |
| > Keyman Developer is a separate app from Keyman, which is the app that lets you use any keyboard created with Keyman Developer. |
and would look like
There was a problem hiding this comment.
When the text came out of Notion, some of the notes were marked with HTML, others with the >, but then the links that were in those paragraphs didn't work, so I ended up removing the markup for notes and tips. My preference would be to wait on adding markup to style the notes.
There was a problem hiding this comment.
Yes, let's worry about integration before minor styling details
There was a problem hiding this comment.
fair enough. I was just looking to have consistency in the styling across the site. But yeah can focus on content now
| title: Introduction | ||
| --- | ||
|
|
||
| [Next: Part 1 - Creating a Keyboard Project →](01-creating-keyboard-project) |
There was a problem hiding this comment.
The knowledge-base folder uses < and > for navigation arrows.
We probably don't want to implement a separate .php file
but for now maybe we just replace the arrows →?
There was a problem hiding this comment.
I think the arrows here are nicer than the ones in the KB and I am not sure why we would be worrying about this anyway @darcywong00?
There was a problem hiding this comment.
Original author used the arrows. I've changed them to wedges.
|
|
||
| ### Installing Keyman Developer | ||
|
|
||
| Keyman Developer is completely free to download and use. You can download it from [https://keyman.com/developer/download](https://keyman.com/developer/download). |
There was a problem hiding this comment.
Should we make all the help.keyman.com links relative?
like
/developer/download
and all the
/developer/17.0/
/developer/18.0/ links become
/developer/current-version/
There was a problem hiding this comment.
This is not a relative link. But relative links on help.keyman.com are a good idea with /developer/current-version in order to avoid linking people into old content (and it also means if content shifts around, we will be prompted to update the tutorial accordingly).
There was a problem hiding this comment.
I tried to follow @mcdurdin 's advice on links, but could easily have goofed it up!
in response to Darcy's suggestion Co-authored-by: Darcy Wong <darcy_wong@sil.org>
|
I'm still short on time to review this, sorry. I would like to sit down and look at integration into the existing content and structure. Then I want to review the content for accuracy and completeness; less worried about style at this point. So am hoping I will get space to do this after I return to Germany next week. |
|
I'm currently enjoying the freezing temps in Florida (and have been accused of bringing them with me from Alaska!). I'll be in UTC-5 time zone for another 10 days, though not working full-time, then UTC-9 from the 13th on. If it would help to meet on zoom to discuss some of this, I'm open to that. |
It may not be necessary, once I get some time, but will let you know. Thanks |
4 participants
Build-bot: skip
Test-bot: skip