Skip to content

Commit

Permalink
full spelling and grammar check/and correction (#71)
Browse files Browse the repository at this point in the history
* full spelling and grammar check/and correction

* First pass at requested changes

* fix missed requested changes

* revert changes to the dictionary

* This line reads better

* This structure sounds better

* Apply suggestions from code review

Co-authored-by: Ben Agricola <717328+benagricola@users.noreply.github.com>
Signed-off-by: bdistin <bdistin@gmail.com>

* more requested changes

* Update docs/millennium-os/manual/chapters/40_gcodes.md

Co-authored-by: Ben Agricola <717328+benagricola@users.noreply.github.com>
Signed-off-by: bdistin <bdistin@gmail.com>

* Update docs/millennium-os/manual/chapters/40_gcodes.md

Co-authored-by: Ben Agricola <717328+benagricola@users.noreply.github.com>
Signed-off-by: bdistin <bdistin@gmail.com>

* fix spelling mistake in suggested change

---------

Signed-off-by: bdistin <bdistin@gmail.com>
Co-authored-by: Ben Agricola <717328+benagricola@users.noreply.github.com>
  • Loading branch information
bdistin and benagricola authored Jul 16, 2024
1 parent 350681a commit a2fae68
Show file tree
Hide file tree
Showing 26 changed files with 418 additions and 424 deletions.
8 changes: 4 additions & 4 deletions docs/casa/bom/printing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ Casa uses 3 different print profiles. Each profile is designed around a 0.4 mm n

## File Naming

With your STL files downloaded and your printer warmed up, you may be wondering which parts to print in your favorite colors? Have no fear, we've got your back - each file is labelled.
With your STL files downloaded and your printer warmed up, you may be wondering which parts to print in your favorite colours. Have no fear, we've got your back - each file is labelled.

### Color
### Colour

All Casa parts are designed to be printed in a single primary colour. Don't let this stop you from mixing and matching colours to make you own colour scheme though!
All Casa parts are designed to be printed in a single primary colour. Don't let this stop you from mixing and matching colours to make your colour scheme unique!

### Quantity Required

Example: `Panel-Clip-A x8.stl`
If any file ends with `x#`, that is telling you the quantity of that part required to build the enclosure.
If any file ends with `x#`, that tells you the quantity of that part required to build the enclosure.

## Printed Parts

Expand Down
4 changes: 2 additions & 2 deletions docs/casa/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Casa has a bi-fold door design which reduces the space it uses and means you can
800 mm wide
390 mm tall

The electronics bay is fitted with DIN rail mounts as standard bay can be reconfigured to suit many different electronics.
The electronics bay is fitted with DIN rail mounts, allowing it to be reconfigured to suit many different electronics.

## Can I use plywood / acrylic panels?
Yes! You can use whatever panel material you like but make sure to consider the impact that changing the material may have on the enclosure. Wooden panels may rot with exposure to coolant, acrylic may shatter on impact, and different materials will have different sound damping properties.
Yes! You can use whatever panel material you like but consider the impact that changing the material may have on the enclosure. Wooden panels may rot with exposure to coolant, acrylic may shatter on impact, and different materials will have different sound-damping properties.

## Are the panels impact resistant / is Casa a substitute for safety glasses?
No. Casas panels are designed to contain light coolants, chips, and sound. Casa is not designed to protect you from flying tools, workpieces, etc.
Expand Down
16 changes: 8 additions & 8 deletions docs/casa/manual/chapters/10_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
Take a deep breath for a second and realize something.

You... yes **YOU**, are about to commit to building a robot that can cut through metal, let alone your squishy human parts.
A machine that can easily electrocute you, cut you or set fire to your whole neighborhood if it's not given the respect it deserves.
A machine that can easily electrocute you, cut you, or set fire to your whole neighborhood if it's not given the respect it deserves.

**Please** give this machine the respect it deserves !!!

!!! warning

Please follow the manual to the letter and perform any additional research you deem necessary before attempting to use Milo for the first time.
Please follow the manual to the letter and perform any additional research necessary before attempting to use Milo for the first time.

If there is anything, and we mean _anything_ that you are curious or unsure about, you are more than welcome to ask us on our discord server.

Expand All @@ -28,28 +28,28 @@ This manual and associated firmware is for the Casa R2 built to the standard BOM

## Bill of Materials

Provided [here](../../bom/sourcing_guide.md) is the bill of materials. Whilst we recommend that you try to stick to this list as much as possible, you're an adult (hopefully) and this is your machine. If there is a substitution that you think would lead to a better machine then feel free! If there is a feature you don't feel is necessary then don't buy the parts for it.
Provided [here](../../bom/sourcing_guide.md) is the bill of materials. We recommend that you try to stick to this list as much as possible; you're an adult (hopefully), and this is your machine. If there is a substitution that you think would lead to a better machine, feel free! If there is a feature you don't feel is necessary, don't buy the parts for it.

Furthermore, there are options in the guide that are up to you to decide on, such as drivers, motors and even control boards. Do your research and find what you need to make your build work for you.
Furthermore, there are options in the guide that are up to you to decide on, such as drivers, motors, and even control boards. Do your research and find what you need to make your build work for you.

## Parts List and Printing Guidelines

The Millennium Machines team has provided a printing list with settings for you as a guideline for printing the parts necessary for the build. This list can be found [here](../../bom/printing_guide.md).

Remember, these settings are only a guideline, and are open to your own interpretations - but we do highly recommend following them to achieve the best mechanical properties for each individual part.
Remember, these settings are only a guideline, and are open to your interpretations - but we highly recommend following them to achieve the best mechanical properties for each part.

<!-- Worth adding loctite info here -->
<!-- Worth adding Loctite info here -->

## T-Nuts Application

This machine requires an immense amount of T-nuts. In the interest of simplifying this manual, we have chosen to omit the installation of T-nuts. Wherever a part interfaces with an extrusion in a way that looks like it requires a T-nut, then it should be considered a part that requires a T-nut.

## Pre-Build Training

Before you head out on your journey to create skynet, it's probably a good idea that you learn a few things. Luckily the Millennium Machines team have put together a curated list of videos to teach you all you need to know - sit back, relax and enjoy.
Before you head out on your journey to create Skynet, it's probably a good idea that you learn a few things. Luckily the Millennium Machines team has put together a curated list of videos to teach you all you need to know - sit back, relax, and enjoy.

<div class="annotate" markdown>
- [How to use heat set inserts](https://www.youtube.com/watch?v=cyof7fYFcuQ&list=PL7zrGeKp_8CTDOmpwZr5JnCSJqEghFh9j&index=32)
- [How to use heat-set inserts](https://www.youtube.com/watch?v=cyof7fYFcuQ&list=PL7zrGeKp_8CTDOmpwZr5JnCSJqEghFh9j&index=32)
- [Electronics connectors and how to use them](https://www.youtube.com/watch?v=y6G_MhQFv3k)
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/contact-us.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contact Us

Building, configuring and using our machines can be a bit of a learning curve, but we're here to help. Do you have a question? Do you want to show off your build? Maybe you just want someone to chat with? Well, why not join our community at the following places:
Building, configuring, and using our machines can be a bit of a learning curve, but we're here to help. Do you have a question? Do you want to show off your build? Maybe you just want someone to chat with? Well, why not join our community at the following places:

- :fontawesome-brands-discord: **Discord** [https://discord.gg/ya4UUj7ax2](https://discord.gg/ya4UUj7ax2)
- :fontawesome-brands-reddit: **Reddit** [/r/MillenniumMachines/](https://www.reddit.com/r/MilleniumMachines/)
Expand Down
6 changes: 3 additions & 3 deletions docs/long-john/assembly_manual/assembly_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
## Mechanical Assembly

!!! info annotate "Threadlocker"
These machines vibrate an immense amount when in use and fasteners are bound to back out. Don’t be afraid to add a little bit of medium-strength threadlocker to your central screw to avoid this problem. Threadlocker should **not** be used on the self tapping screws as the chemicals in threadlocker may damage the ABS and cause it to weaken.
These machines vibrate intensely when running and fasteners are bound to back out. Don’t be afraid to add a little bit of medium-strength threadlocker to your central screw to avoid this problem. Threadlocker should **not** be used on the self-tapping screws as the chemicals in threadlocker may damage the ABS and cause it to weaken.

![Long-John Toolsetter assembly image](./img/assembly_image_1.png){: .shadow}

## Electronics Assembly

!!! info annotate "Are you building an LDO kit?"
LDO have written a fantastic supplementary guide for the wiring included with their kit, which is pre-cut, pre-crimped, and pre-soldered! If you're building an LDO kit then check out their guide [here!](https://www.ldomotion.com/#/guide/Milo-CNC-V15-Wiring-Guide)
LDO has written a fantastic supplementary guide for the wiring included with their kit, which is pre-cut, pre-crimped, and pre-soldered! If you're building an LDO kit then check out their guide [here!](https://www.ldomotion.com/#/guide/Milo-CNC-V15-Wiring-Guide)

Plug the toolsetter into the `Z_MAX` endstop connector. Note that your wire colours may be different to those shown in the images.
Plug the toolsetter into the `Z_MAX` endstop connector. Note that your wire colours may be different than those shown in the images.

![Long-John Toolsetter wiring diagram](./img/toolsetter_wiring.png){: .shadow}
12 changes: 8 additions & 4 deletions docs/long-john/bom/sourcing_and_print_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

## Kits

Currently there are no approved kits available, but fear not - the toolsetter uses easily obtainable parts and you can find a full list of them below!
The toolsetter is available as part of the Milo kit from LDO, but may also be available separately - contact your local LDO reseller for details.

Alternatively, the toolsetter uses easily obtainable parts and you can find a full list of them below!

<!-- Should update that there is in-fact an LDO kit available at several retailers. -->

## Individual Parts

Expand All @@ -17,17 +21,17 @@ Currently there are no approved kits available, but fear not - the toolsetter us
| Cables | JST Connector 2 Position | JST-XH | 1 |

!!! info annotate "Return Spring"
The Long John Toolsetter can be fitted with a compression spring to help the contact return. You may choose to fit this, however it isn't required. Any appropriately sized low force compression spring should be suitable.
The Long John Toolsetter can be fitted with a compression spring to help the contact return. You may choose to fit this, however it isn't required. Any appropriately sized low-force compression spring should be suitable.

# Printing Guide

The toolsetter part has a sacrificial floor to allow unsupported features to be printed successfully, and overhangs that will become more difficult to print with thicker layers. These floors are designed to work at a layer height of **0.2mm**, so they may not be sliced correctly if your layer height is not 0.2mm.

**Unless you're willing to experiment and almost certainly waste filament, stick with 0.2mm layers.**

We provide a **Minimum Wall Thickness** for every printable part, which is the minimum **total** thickness of your perimeter lines and top and bottom solid layers. This depends on the size of your nozzle and line width settings in your slicer so must be calculated.
We provide a **Minimum Wall Thickness** for every printable part. This value is the minimum **total** thickness of your perimeter lines and top and bottom solid layers. The size of your nozzle and line width settings (in your slicer) contribute to this value, so the number of parameter lines needs to be calculated.

Given a 0.4mm nozzle, 100% perimeter line width, 0.2mm layers and a minimum wall thickness of 2.4mm, you would set your slicer to generate a _minimum_ of 6 perimeters and 12 top / bottom layers.
Given a 0.4mm nozzle, 100% perimeter line width, 0.2mm layers, and a minimum wall thickness of 2.4mm, you would set your slicer to generate a _minimum_ of 6 perimeters and 12 top / bottom layers.

## The Long John Toolsetter
| **Name** | **Infill** | **Min. Wall Thickness** | **Material** | **Qty** | **Accent Color** |
Expand Down
4 changes: 2 additions & 2 deletions docs/millennium-os/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# MillenniumOS - An "Operations System" for RepRapFirmware

MillenniumOS is an addon for RepRapFirmware 3.5+ which implements some high-level functionality around work-piece probing, tool changes and tool setting that aim to make Millennium Machines the simplest route for novice machinists to make their first cuts confidently and safely.
MillenniumOS is an add-on for RepRapFirmware 3.5+ that implements high-level functionality for work-piece probing, tool changes, toolsetting, spindle control, and coolant control. It aims to provide an intuitive platform for novice machinists to make their first cuts confidently and safely on a Millennium Machine.

MillenniumOS provides post-processors for common CAD/CAM packages (currently Fusion360 and others that use the same `.cps` format), as well as implementing a gcode dialect that makes machining on a Milo feel a little more like using a 3D printer - that is, the gcode generated by our post-processors is able to walk the operator through work-piece probing and tool changes that otherwise would be entirely manual or require significant implementation of custom macros to do safely.
MillenniumOS provides post-processors for common CAD/CAM packages (currently Fusion360 and others that use the same `.cps` format), as well as implementing a gcode dialect that makes machining on a Milo feel a little more like using a 3D printer - that is, the gcode generated by our post-processors can walk the operator through work-piece probing and tool changes that otherwise would be entirely manual or require significant implementation of custom macros to do safely.

- [Github Page](https://github.com/MillenniumMachines/MillenniumOS)
- [Introduction](./manual/chapters/10_introduction.md)
Expand Down
Loading

0 comments on commit a2fae68

Please sign in to comment.