CODAIT / pardata

https://pardata.readthedocs.io/en/latest/
Apache License 2.0
17 stars 6 forks source link

Add initial schema doc #241

Closed xuhdev closed 3 years ago

xuhdev commented 3 years ago

Add a summary page of schema file format

Part I of #99


Checklist:

- Does this pull request close an issue? We encourage you to open an issue first if this pull request (PR) is not a minor change. - [ ] No - [ ] The change in this pull request is minor. - [x] Yes - #99 For the following questions, only check the boxes that are applicable. - [x] Ensure that the pull request text above the horizontal line is descriptive. - [x] Add/update relevant tests. - [x] Add/update relevant documents. - Do you have triage permission of this repository? - [ ] No - You are good. - [x] Yes - Does this pull request close an issue? - [ ] No, this pull request also acts as an issue by itself. - [ ] Assign yourself. - [ ] Label this pull request. - [ ] Put a milestone. - [ ] Put this pull request under "In Progress" or "Under Review" pipeline on ZenHub. - [ ] Put this pull request under the appropriate epic on ZenHub. - [ ] Put an estimate on ZenHub. - [ ] Add dependency relationship with other issues/pull requests on ZenHub. - [x] Yes, this pull request addresses an issue and does not act as an issue. - [x] Connect this pull request to the underlying issue on ZenHub. - [x] DON'T: - DON'T assign yourself or anyone else. - DON'T label. - DON'T put a milestone. - DON'T put this pull request under any epic on ZenHub. - DON'T put an estimate on ZenHub. - [x] When the pull request is ready, request review.