diff --git a/docs/misc/upgrade/index.md b/docs/misc/upgrade/index.md new file mode 100644 index 000000000..db199ff70 --- /dev/null +++ b/docs/misc/upgrade/index.md @@ -0,0 +1,26 @@ +--- +description: Instructions for Upgrading the LumenPnP +--- +# Upgrade to v4 + +v4 has enough changes from the previous release that it's most effective to fully disassemble your current LumenPnP. There are effectively no subassemblies that have not be updated in some way, so a full rebuild is the fastest way to get your machine upgraded. + +We highly recommend **picking a version**. Select a [release](https://github.com/opulo-inc/lumenpnp/releases) starting with `v4` from the LumenPnP Github page and stick to it! + +All upgrade parts available on the [Opulo Web Store](https://www.opulo.io/collections/parts) are suited to upgrading to v4. + +## Parts + +When determining if you have the right parts, always reference the BOM. This is attached to each release. Download the zip file, unzip it, and open the HTML page with your browser. Make sure you have purchased all the parts needed, or already have them from disassembling your old build. + +You'll have to print parts as well. There are printing instructions in the BOM file. + +If you have questions, please don't hesitate to [reach out](https://www.opulo.io/pages/contact-support). + +## Build + +With your parts and tools collected, dive into building! We *highly* recommend opening the [FreeCAD model of the LumenPnP](https://github.com/opulo-inc/lumenpnp/blob/main/pnp/cad/assembly.FCStd) for reference as you build. + +The best place to start from is [this OHAI page](https://ohai.opulo.io/lumen/x-gantry/). Note that OHAI is written as internal assembly instructions for Opulo employees. It will reference jigs, tools, and other specifics that you might not have. This is the currently most accurate guide for upgrading your machine until dedicated build instructions are written. + +If you have questions, please don't hesitate to [reach out](https://www.opulo.io/pages/contact-support) and we'll be happy to help! diff --git a/docs/misc/versions-upgrades/img/photon-packet.png b/docs/misc/versions/img/photon-packet.png similarity index 100% rename from docs/misc/versions-upgrades/img/photon-packet.png rename to docs/misc/versions/img/photon-packet.png diff --git a/docs/misc/versions-upgrades/img/update-speed.png b/docs/misc/versions/img/update-speed.png similarity index 100% rename from docs/misc/versions-upgrades/img/update-speed.png rename to docs/misc/versions/img/update-speed.png diff --git a/docs/misc/versions-upgrades/index.md b/docs/misc/versions/index.md similarity index 99% rename from docs/misc/versions-upgrades/index.md rename to docs/misc/versions/index.md index d0aed406a..bd41e0d59 100644 --- a/docs/misc/versions-upgrades/index.md +++ b/docs/misc/versions/index.md @@ -2,7 +2,7 @@ description: Outlining the different versions and features of the LumenPnP --- -# LumenPnP Versions and Upgrades +# LumenPnP Versions The LumenPnP is always being upgraded and improved. This page is a reference for determining what and how to upgrade parts of your machine, depending on what version you built or bought. diff --git a/mkdocs.yml b/mkdocs.yml index 4097f106f..49867560b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -187,7 +187,8 @@ nav: - Extracting Your Config Files: guides/extracting-your-config-files/index.md - Misc: - - Machine Versions and Upgrades: misc/versions-upgrades/index.md + - Machine Versions: misc/versions/index.md + - Upgrade: misc/upgrade/index.md - Backlash Compensation: misc/backlash-compensation/index.md - Standalone Feeder Control: misc/standalone-feeders/index.md - Photon Protocol: misc/photon/index.md