search

pez-globo / pufferfish-software

All software for the Pufferfish ventilator.
Apache License 2.0
0 stars 1 forks source link

Base Documentation configuration #280

Closed Sudhir-dev closed 3 years ago

Sudhir-dev commented 3 years ago

This PR includes

Run "yarn document" to generate docs

ethanjli commented 3 years ago

Would it be reasonable add docs to .gitignore? We can always add building the docs in Github Actions as an automatic thing, to make a downloadable archive available as a build artifact.

It looks like the frontend checks are failing in Github Actions.

For records-keeping:

  1. This project is licensed under Apache License v2.0 for any software, and Solderpad Hardware License v2.1 for any hardware - do you agree that your contributions to this project will be under these licenses, too?
  2. Were any of these contributions also part of work you did for an employer or a client?
  3. Does this work include, or is it based on, any third-party work which you did not create?
ethanjli commented 3 years ago

Looks good to merge. @Sudhir-dev Once you fill in the three questions for records-keeping, let's merge this.

Sudhir-dev commented 3 years ago
  1. This project is licensed under Apache License v2.0 for any software, and Solderpad Hardware License v2.1 for any hardware - do you agree that your contributions to this project will be under these licenses, too? Yes
  2. Were any of these contributions also part of work you did for an employer or a client? No
  3. Does this work include, or is it based on, any third-party work which you did not create? No