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.

Sign up for GitHub

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

Jump to bottom

finish the documentation #3

Open
4 of 14 tasks
noah1510 opened this issue Aug 16, 2023 · 0 comments
Open
4 of 14 tasks

finish the documentation #3

noah1510 opened this issue Aug 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@noah1510
Copy link
Owner

noah1510 commented Aug 16, 2023 •
edited
Loading

Now that more languages are going to be added the documentation needs to be more clear and complete.

  • document the json formats (-> type_formats.md)
    • combinations.json
    • constatns.json
    • units.json
  • document the python data structure
    • document the per unit data
    • document the per target data
  • document target specifications
    • add language requirements and considerations
    • add implementation requirement
    • add documentation for the target json format
    • add documentation for target structure
    • add documentation for writing templates
    • add documentation on writing tests
@noah1510 noah1510 added enhancement New feature or request documentation Improvements or additions to documentation labels Aug 16, 2023
@noah1510 noah1510 added the good first issue Good for newcomers label Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@noah1510