open-source-rover

open-source-rover copied to clipboard

Format Markdown

1

Issue #317 proposes the introduction of built documentation using *MkDocs*. There are currently a few bugs in the rendered HTML generated by *MkDocs*. However, these can all be fixed with...

sethfischer

Documentation build proof-of-concept using MkDocs

6

Documentation build proof-of-concept using [*MkDocs*](https://www.mkdocs.org/). Two *MkDocs* themes have been investigated: * [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) #360 **[Currently deployed](https://osr-demo.readthedocs.io/)** * ~~[Material](https://squidfunk.github.io/mkdocs-material/) #318~~ Preference has been indicated for #360 as it supports versioned documentation....

sethfischer

This is a proof-of-concept. See #317 for discussion. Closes #317

sethfischer

[MkDocs](https://www.mkdocs.org/) with [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme which has version support. Closes #317

sethfischer

Added optional CAD parts for clamping turnbuckle holder

2

Added turnbuckle holder that clamps to the 0.5" tubes instead of requiring glue. Includes FreeCAD design files

dcschooley

Update BOM/docs with a good alternative for Traxxas 5374X wheels

6

We're encountering out-of-stock's on the Traxxas wheels, for example https://opensourcerover.slack.com/archives/C01D07KNKJM/p1620218389012800 They're currently out of stock on the [dollarhobbyz website link](https://www.dollarhobbyz.com/collections/all/products/traxxas-2-talon-tires-gemini-black-chrome-wheels-5374x) from the BOM, though they can be found [on amazon](https://www.amazon.com/TRAXXAS-5374X-BRUSHLESS-REVO-WHEEL/dp/B00C5T2GRY)....

apollokit

See also #356 Figure 4 needs its own picture Figure 5b shows the wrong screws (it uses the S48 srews). Instead B1 should be used which aren't visible.

Achllle

JST-XH connectors not included in BOM or instructions for GoBilda encoder connections

2

- [ ] add 4 pin JST-XH connectors to BOM - [ ] add to instructions in right place

Achllle

Reference CAD location in Parts List for 3d printed parts

1

Problem: Right now, when looking at the CAD parts that are in various places in the repo, it can be difficult to understand if the part is needed, why it...

JoshSharpe

Figure style

3

Figures are displayed in two styles. 1. Image followed by an emphasized caption: ```markdown  **Figure 6** ``` 2. Figure and caption within a table: ```markdown | | |:-:| |...

sethfischer