diff --git a/docs/guides/docker_skill_installation.md b/docs/guides/docker_skill_installation.md new file mode 100644 index 00000000..260a0ba3 --- /dev/null +++ b/docs/guides/docker_skill_installation.md @@ -0,0 +1,29 @@ +# Docker Skill Installation +This guide summarizes how to add custom skills to a Docker deployment. + +## Steps +1. Locate your `neon.yaml` configuration file. +2. Create or add to the configuration list `skills`, `default_skills` +3. Add any desired skill(s) to the list by PyPI name or URL starting with `git+` +4. Restart the `neon-skills` container + +## Example Configuration +```yaml +skills: + default_skills: + - git+https://github.com/neongeckocom/skill-date_time@dev + - neon-skill-translation>=0.3.1a4 + - neon-homeassistant-skill +``` +> Skills can be specified by URL or PyPI package spec (versioning optional) + +## Troubleshooting +- Make sure the `neon.yaml` file being changed is the one used by Docker containers. +- Make sure any skill package names or URLs are valid. +- Check the `neon-skills` container logs in Docker or `skills.log` file for errors. + +## Tags +- skill installation +- install skill +- docker +- skill development \ No newline at end of file diff --git a/docs/guides/make_a_boot_drive_using_a_computer.md b/docs/guides/make_a_boot_drive_using_a_computer.md new file mode 100644 index 00000000..830e5f3e --- /dev/null +++ b/docs/guides/make_a_boot_drive_using_a_computer.md @@ -0,0 +1,37 @@ +# Make a Boot Drive Using Your Computer +How to use your Windows computer to make a USB or SSD boot drive for your Mark II. + +## Requires +A portable drive, either USB or SSD with a USB version 3.0 or greater connection. + +## Steps +1. Download the Neon OS to your computer from the link on this page: https://neon.ai/NeonAIforMycroftMarkII +2. Download a (free) imaging program, if you don't have one already. We suggest Raspberry Pi Imager or Balena Etcher. +3. Plug the drive you want to update into your computer. +4. Open your imaging program. +- If using Raspberry Pi Imager: + - Under the 'Operating System' menu, select 'Use Custom'. + - Locate and select the Neon OS image you downloaded. + - Under 'Storage', select the drive you intend to write to. + - Click 'Write' and wait for the image to be written and verified. This takes several minutes, depending on your system. +- If using Balena Etcher + - Under the '+', choose 'Flash from file'. + - Locate and select the Neon OS image you downloaded. + - Under 'Select target', select the drive you intend to write to. + - Click 'Flash' and wait for the image to be written and verified. This takes several minutes, depending on your system. +6. Remove the USB or SSD drive from your computer. +7. Disconnect power from your Mark II. +8. Plug the newly imaged USB drive into the upper USB port closest to the center of your Mark II (Port 0). +9. Reconnect power to your Mark II. +10. Set up as normal, and you're on the new version! + +## Troubleshooting +- Imaging using a computer is not quite 100% reliable. If your newly imaged drive does not perform well, try imaging it again. +- If you get an error that verification has failed, try imaging again. +- If you get an error that it is unable to write to your drive, try erasing the drive first using Raspberry Pi imager, and then try imaging again. +- If you get repeated errors, the drive may be faulty or your system may be having problems writing to the disk. You could try using a different computer, try imaging using your Mark II's "Make Bootable Media" skill, or order an imaged drive from Neon AI at https://neonai.square.site/ + +## Tags +- imaging +- make a boot drive +- computer diff --git a/docs/guides/make_bootable_media.md b/docs/guides/make_bootable_media.md new file mode 100644 index 00000000..487b2404 --- /dev/null +++ b/docs/guides/make_bootable_media.md @@ -0,0 +1,23 @@ +# Make Bootable Media +How to image a drive using your Mark II's "Make Bootable Media" intent. + +## Requires +Two USB drives, or a USB drive and an SSD drive, or two SSD drives with supplemental power to one of them. Any data on the secondary drive will be erased by this process. + +## Steps +1. Start with your machine booted up, with the boot drive in the upper USB port closest to the center of the back of your Mark II. +2. Plug in your secondary drive in the second USB port, which is closer to the edge of the back of your Mark II. +3. Say "Hey Neon, make bootable media". +4. Follow the prompts. +5. When finished, shut down your Mark II and unplug the power. +6. Unplug the boot drive you were using to run your Mark II and set it aside. +7. Plug power back in to your Mark II (you can move the new boot drive to the other port, but it is not necessary unless you have an extra drive you want to plug in). +8. Congratulations, you're on the new version! +9. If you would like to use the new version on your original boot drive, simply repeat this process. + +## Troubleshooting +- The Mark II may not provide enough power to run two SSD drives at the same time. + +## Tags +- make bootable media +- image boot drive diff --git a/docs/guides/upgrade_paths_for_neon_os_v2.md b/docs/guides/upgrade_paths_for_neon_os_v2.md new file mode 100644 index 00000000..839fdb81 --- /dev/null +++ b/docs/guides/upgrade_paths_for_neon_os_v2.md @@ -0,0 +1,15 @@ +# Ugrade Paths for Neon OS Version 2.0 on the Mark II +Describes your basic options for upgrading your Neon OS to V2.0. + +## Options +1. Make a version 2.0 boot drive on your Mark II using the "Make Bootable Media" skill. +2. Make a version 2.0 boot drive using a computer. +3. Order a free USB with the image on it from Neon AI with coupon code "UPGRADE". Our square site is https://neonai.square.site/ +4. Order an SSD from our Square site for $29.99 with coupon code "UPGRADE". The site is https://neonai.square.site/ +5. Visit the upgrade page on our website at https://neon.ai/V2 for written directions, how-to videos, and open tech support calls. That's https://neon.ai/V2 + + ## Tags +- upgrade +- upgrade choices +- version 2 +- version 2.0 diff --git a/mkdocs.yml b/mkdocs.yml index a35f56e0..62a727b0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -31,12 +31,17 @@ nav: - Neon Image Recipes: neon_os/neon_image_recipe.md - Developer References: neon_os/developers.md - Tips: neon_os/tips.md - - Quick Reference Guides: + - Quick References: - Terminal: quick_reference/terminal.md - Logs: quick_reference/logging.md - Configuration: quick_reference/configuration.md - Installing Skills: quick_reference/installing_skills.md - Installing Plugins: quick_reference/installing_plugins.md + - Guides: + - Docker Skill Installation: guides/docker_skill_installation.md + - Make a Boot Drive Using a Computer: guides/make_a_boot_drive_using_a_computer.md + - Make a Boot Drive Using a Mark 2: guides/make_bootable_media.md + - Upgrade Paths for Neon OS v2: guides/upgrade_paths_for_neon_os_v2.md - Skill Development: - Voice User Interface Design Guidelines: - What Can A Skill Do?: skill_development/voice-user-interface-design-guidelines/what-can-a-skill-do.md