Initial Docusaurus setup for GH-Pages #32
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Author
|
@edoyango, when you are able, could you please check this PR, I'm just folding in some Markdown documentation onto main so I can deploy on GitHub Pages, cheers 😄 |
edoyango
reviewed
Jan 20, 2026
edoyango
approved these changes
Jan 20, 2026
Collaborator
edoyango
left a comment
edoyango
left a comment
There was a problem hiding this comment.
Looks good! I've added a handful of comments but they're all suggestions, with the exception of mentioning over-fitting - that's actually quite important. Some other general suggestions:
- Add a link to your docs in the readme (I guess you were going to do this after the site is actually deployed)
- in training-output.md, I suggest that you include links to more in-depth guides of how to interpret the output, just so you don't have to write it yourself. e.g. https://neptune.ai/blog/f1-score-accuracy-roc-auc-pr-auc or https://docs.ultralytics.com/guides/yolo-performance-metrics/
- I can see that you've added some images of denoise workflows, but it could be good to show off some of your metrics that are included in your publication (maybe you planned on doing this after publishing).
Co-authored-by: Edward Yang <94523015+edoyango@users.noreply.github.com>
… into gh-pages pulling upstream commits
Collaborator
Author
|
@edoyango awesome thanks, having implemented all suggestions, will need one more review before I can merge to main |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Copied across docusaurus documentation project from personal git repo for deployment on PartiNet github pages