Hardocs guide

Use Case:

Updating project.json using a <Part>yml file

Describe as use case example

Describe this example to showcase how the application should work

{
  "projectName": {
    "authors": "",
    "version": "",
    "description": "",
    "keywords": [],
    "gitRepo": []
  },
  "parts": [
    {
      "partId": "",
      "name": "name",
      "fileName": "partNameConvention",
      "description": "",
      "image": "urlLink",
      "quantity": "integer",
      "cadFiles": [
        {
          "name": "",
          "type": "step",
          "path": "/cam/file.step"
        }
      ],
      "camFiles": [
        {
          "name": "",
          "type": "stl",
          "path": "/cam/file.stl"
        }
      ],
      "cost": "integer",
      "suppliers": [
        {
          "supplierName": "",
          "partNo": "",
          "price": "",
          "link": ""
        }
      ]
    }
  ],
  "orders": [{}]
}

A yaml file representing a part's information

---
part:
  - partId: ''
    name: name
    fileName: partNameConvention
    description: ''
    image: urlLink
    quantity: integer
    cadFiles:
      - name: ''
        type: step
        path: '/cam/file.step'
    camFiles:
      - name: ''
        type: stl
        path: '/cam/file.stl'
    cost: integer
    suppliers:
      - supplierName: ''
        partNo: ''
        price: ''
        link: ''

← Module dev guidelines →