search

VirtualPhotonics / VTS

Virtual Tissue Simulator
https://virtualphotonics.org
Other
34 stars 9 forks source link

Publish documentation to GitHub Pages #93

Closed dcuccia closed 1 year ago

dcuccia commented 1 year ago

This should add DocFx metadata and a GitHub action that will publish an update to the documentation a) on demand ("workflow dispatch") and b) upon any commit to main (master). This will keep the documentation in sync with the code changes. I think all we need to do is enable Pages on the main site. Note: recommend "squashing" the commits when accepting and merging the PR, the individual commits aren't really helpful.

Fixes #92

dcuccia commented 1 year ago

@lmalenfant  think you can checkout and edit the code with the GitHub CLI with gh pr checkout 93 and push any edits you want.

dcuccia commented 1 year ago

Update to the above. From here: 

git fetch origin pull/ID/head:BRANCH_NAME

where BRANCH_NAME is the number of the PR ticket (93 in this case).

I think this is a useful exercise (vs creating an extra branch) because it mimics how most outside contributors will be interacting with the team.

lmalenfant commented 1 year ago

@dcuccia, I noticed that in one of your commits, all of the documentation files were committed, I think that even if we squash the commit, these files will still be in the repository history. Let me pull your changes and then add them directly to a separate branch so we don't end up inflating the repo. We can try this forking with a branch another time because I agree this would be a useful exercise.

dcuccia commented 1 year ago

Oh, I assumed those would be wiped with the squash. Maybe not? Would be great to know how to do this properly, when there are lots of files involved, otherwise it might be a lot of work for the maintainer. It's probably best practice for the PR submitter to manage this complexity, I just don't have any experience with it.

dcuccia commented 1 year ago

I see now what you meant by pull changes and add them. Thought you'd be going through the PR file by file, but realize you can pull, make a copy, checkout new branch, paste. I can definitely do that and issue a new PR, if you'd like.

lmalenfant commented 1 year ago

Yes I was able to pull your code and just update the files. It's working! :) https://virtualphotonics.github.io/VTS/

Thank you for this, it's awesome! It needs a little more work but I can fix it on the branch and then switch it to master.

dcuccia commented 1 year ago

Awesome! You're welcome. :)

lmalenfant commented 1 year ago

I am closing this PR, I will create another one with the branch that I created.