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.

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

docs: Provide better instructional materials #208

Merged
merged 14 commits into from
Jun 26, 2024

Conversation

SoloSynth1
Copy link
Collaborator

This PR:

  • Revises existing instructional materials i.e. README.md, CONTRIBUTING.md
  • Updates ReadtheDocs structure and add pages for detailed guides for usage and development.

Closes #205.

@SoloSynth1 SoloSynth1 self-assigned this Jun 26, 2024
@SoloSynth1 SoloSynth1 linked an issue Jun 26, 2024 that may be closed by this pull request
7 tasks
@SoloSynth1 SoloSynth1 marked this pull request as ready for review June 26, 2024 04:53
@SoloSynth1
Copy link
Collaborator Author

Marking this PR as ready for review.

@jinyz8888 @tonyshumlh @JohnShiuMK Please note that some links in README.md does not work yet as the ReadtheDocs page has not been rendered. I have tested locally and the links should work once this PR is merged into main triggering RTD's rendering action on latest.

@tonyshumlh
Copy link
Collaborator

@SoloSynth1 i tried to run through every command in README and most things are fine, except the export of Evaluation Report that has error in lacking package tabulate. (shown below).
Can we include it in our Poetry pyproject.toml, e.g. tabulate = "^0.9.0"?
Screenshot 2024-06-26 at 12 11 12 PM

@SoloSynth1
Copy link
Collaborator Author

@SoloSynth1 i tried to run through every command in README and most things are fine, except the export of Evaluation Report that has error in lacking package tabulate. (shown below).

Can we include it in our Poetry pyproject.toml, e.g. tabulate = "^0.9.0"?

Screenshot 2024-06-26 at 12 11 12 PM

What's your export target format? Is it HTML?

@SoloSynth1
Copy link
Collaborator Author

Also if possible, would you mind to paste the whole error stack?

docs/install_devel_build.md Show resolved Hide resolved
docs/install_devel_build.md Show resolved Hide resolved
@JohnShiuMK
Copy link
Collaborator

Also if possible, would you mind to paste the whole error stack?

Screenshot 2024-06-26 at 12 58 02 PM Screenshot 2024-06-26 at 12 58 10 PM Screenshot 2024-06-26 at 12 58 19 PM Screenshot 2024-06-26 at 12 58 28 PM

@JohnShiuMK
Copy link
Collaborator

JohnShiuMK commented Jun 26, 2024

I think adding tabulate = "^0.9.0" under [tool.poetry.dependencies] in pyproject.toml will quickly solve the problem

@JohnShiuMK
Copy link
Collaborator

in the README acknowledgement: Dr. Simon Goringfor

@SoloSynth1
Copy link
Collaborator Author

Also if possible, would you mind to paste the whole error stack?

Screenshot 2024-06-26 at 12 58 02 PM Screenshot 2024-06-26 at 12 58 10 PM Screenshot 2024-06-26 at 12 58 19 PM Screenshot 2024-06-26 at 12 58 28 PM

Will try to reproduce this in my environments once I get back to campus

@SoloSynth1
Copy link
Collaborator Author

in the README acknowledgement: Dr. Simon Goringfor

Fixed

Copy link
Collaborator

@JohnShiuMK JohnShiuMK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's fantastic, thanks!

@JohnShiuMK JohnShiuMK merged commit 5c8634b into main Jun 26, 2024
2 checks passed
@JohnShiuMK JohnShiuMK deleted the 205-provide-better-instructional-materials branch June 26, 2024 21:11
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.

Provide better instructional materials
3 participants