Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct the docs (no substantial changes, mostly grammar and formatting) #1

Merged
merged 3 commits into from
Jan 15, 2021

Conversation

pavel-kirienko
Copy link
Member

@pavel-kirienko pavel-kirienko commented Jan 14, 2021

@j3qq4hch it's not a bad start; certainly an improvement over our prior projects. In this changeset I am introducing certain non-essential corrections to the docs that need reviewing. There have been violations that you've missed because you seem to have been deviating from the prescribed policy (for instance, you did not use Grammarly).

I found problems with the sources:

  • Eagle complains that the schematics and the board are inconsistent (I am using Eagle 9.6.1).
  • The design files include a board file named B.brd that is not accounted for in the documentation. What is the purpose of this unit and why is it not documented anywhere?

Edit:

  • The manufacturing docs do not explain the origin of the 2mm shafts.
  • We need @dimracer to approve the design based on the wooden pins.

j3qq4hch pushed a commit that referenced this pull request Jan 15, 2021
* source files consistency fix

* Delete part B.brd

* Revert "Delete part B.brd"

This reverts commit 4a45031.

* Revert "source files consistency fix"

This reverts commit 015ba01.

* fixes for #1

* Update readme.md

* Update readme.md

* Update manufacturing/readme.md

Co-authored-by: Pavel Kirienko <pavel.kirienko@gmail.com>

* Update readme.md

* Update readme.md

* Update readme.md

Co-authored-by: Alexander Sysoev <alexander.sysoev@zubax.com>
Co-authored-by: Pavel Kirienko <pavel.kirienko@gmail.com>
@j3qq4hch
Copy link
Contributor

The schematics and the board should be now consistent, check again.

@dimracer dimracer merged commit 647cdbf into main Jan 15, 2021
@dimracer dimracer deleted the release-preparation-v0.1 branch January 15, 2021 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants