Seth Fischer

Results 18 comments of Seth Fischer

It is worth noting that the Arduino shield is using the "TP" designator prefix **TP1**-**TP8** so already complies with *ASME Y14.44*.

I have prepared #363 which has all Markdown files formatted with the tool *[markdownlint](https://github.com/DavidAnson/markdownlint)*. It is currently a draft as it affects all Markdown files. Having the same formatting access...

> what is the upkeep for this? Is it auto updated from updates to the Readme docs? Yes. The built site is auto updated from the Readme docs. *Read the...

Screenshot of the documentation built with theme [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). ![osr-demo readthedocs io_2022-02-20_material_for_mkdocs](https://user-images.githubusercontent.com/2492233/154833439-29a47ab0-d7da-4809-9540-b057ff1b9811.png)

Screenshot of the documentation built with theme [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs). This theme has version support. ![osr-demo readthedocs io_2022-02-20_readthedocs_for_mkdocs](https://user-images.githubusercontent.com/2492233/154835114-9cc3a489-3e21-41ed-9983-7cb19d2195e1.png)

Which is the preferred figure style?

Investigation into hosting versioned MkDocs on GitHub Pages. This is a possible alternative to MkDocs hosted on readthedocs. * Need to use the MkDocs Material theme. See https://github.com/nasa-jpl/open-source-rover/issues/317#issuecomment-1046182232 above for...

Comparison of hosting options: Read the Docs vs. GitHub Pages. | Feature | [Read the Docs](https://readthedocs.org/) | [GitHub Pages](https://docs.github.com/en/pages) | |-------------------------|--------------------------------------------------------------------------------------------|-----------------------------------------------------------------| | Automated deploy | Yes | Manual action for...

> I think I asked this already, but can you remind me why you couldn't get relative links to work? The [readthedocs documentation](https://mkdocs.readthedocs.io/en/0.15.3/user-guide/writing-your-docs/#internal-hyperlinks) and [github pages documentation](https://github.blog/2016-12-05-relative-links-for-github-pages/) are pretty explicit...

> I'm fine with read the docs. I do like that I don't need an account for read the docs though with the pages option. @Achllle I think GitHub Pages...