Skip to content

67 write a simple documentation with examples - #71

Merged
sadda merged 19 commits into
mainfrom
67-write-a-simple-documentation-with-examples
Oct 23, 2026
Merged

sadda merged 19 commits into
mainfrom
67-write-a-simple-documentation-with-examples

Conversation

@haitao-ZCU

Copy link
Copy Markdown
Collaborator

A WINDING.md, including how to use compute_winding_layout (with two worked examples, 3f_36s and 5f_40s machines), the meanings of the outputs, double layer windings, and the relation to coil_pitch/belt_offset.

@haitao-ZCU haitao-ZCU linked an issue Oct 22, 2026 that may be closed by this pull request
@sadda

sadda commented Oct 22, 2026

Copy link
Copy Markdown
Collaborator

@haitao-ZCU Please incorporate the documentation into CI. Something similar to what we did in WildlifeDatasets.

@haitao-ZCU

haitao-ZCU commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator Author
  • move machine_design/generic/WINDING.md to docs/WINDING.md
  • add a brief introduction of MachineDesign project in index.md (docs/index.md, similar to Wildlife datasets project).
  • update github/workflows/, adding ci.yml, docs.yml, ruff.yml, and tests.yml

@sadda

sadda commented Oct 23, 2026

Copy link
Copy Markdown
Collaborator

@haitao-ZCU Good, two small changes, then we can merge it.

  • Remove the hard enters and write it as paragraphs.
  • Remove the last paragraph; we do not care about historical artefacts.

@haitao-ZCU

Copy link
Copy Markdown
Collaborator Author
  • Hard enters have been removed.
  • The original last paragraph has been removed.

@sadda

sadda commented Oct 23, 2026

Copy link
Copy Markdown
Collaborator

@haitao-ZCU Sorry, one more thing. Add a link to the README for the documentation. Also, please try to be a bit proactive and come up with these things by yourself.

@haitao-ZCU

Copy link
Copy Markdown
Collaborator Author
  • Documentation link is added in README.md.
  • MIT license is added.

@sadda
sadda merged commit d0fa825 into main Oct 23, 2026
7 checks passed
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.

Write a simple documentation with examples

2 participants