-
Notifications
You must be signed in to change notification settings - Fork 64
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
New docs #236
New docs #236
Conversation
✅ Deploy Preview for monad-bayes-old-docs canceled.
|
❌ Deploy Preview for monad-bayes-site failed.
|
✅ Deploy Preview for monad-bayes canceled.
|
@mknorps @idontgetoutmuch Here are what the new docs look like: https://monad-bayes.netlify.app/ The motivation was that currently I'm hosting two separate sites, one for the docs and one for the notebooks, and this both looks cleaner and is easier to maintain. I think this repo is set up such that I can't merge this in myself, so if one of you could, that would be great, and then I can delete the old websites. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The site looks elegant! It has better user experience and you modernized it well. I like it very much.
Apart from the comments within the code, I have few comments and suggested changes regarding the PR:
- in
docs/images
plot.pgn and plot copy.pgn are duplicates. Remove the copy. - How does
tintin
work here? I see a.tintin.yml
file but no reference to it in teh code and requirements. - Do we still need
monad-bayes-site
folder? - For the structure of the project it would be better if the code to generate documentation was in a separate folder.
- is
monad-bayes-site.cabal
andstack.yaml
withindocs
still needed?
on: | ||
push: | ||
branches: | ||
- newdocs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change trigger to push on master and add cache.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wasn't sure how to add cache, but added master.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should work:
- name: Setup caching
uses: actions/cache@v3
with:
key: ${{ github.sha }}
path: .cache
For some reason, the --force and Python 3.8 were both necessary for CI and netlify to work respectively, but I changed the other things. |
That is inconvenient, but we can leave with this for now. And what about:
Is also mathjax no longer needed? |
I thought I removed it. I don't see it in the repo locally.
Now done.
Re-added. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! The code structure looks better :)
One last thing - remove mkdocs.yaml from the main directory.
If you want to experiment a bit with caching, as I suggested in this comment it would be great, but if you do not have time for this now, please create an issue for later not to forget about it.
OK, removed, and issue created. |
Hm, netlify works fine, but something with CI fails. I'm a bit stumped. Any ideas? |
Oh right, it's failing for the old site. Let me remove it... |
Now passes CI, should be ready to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks OK now. Thank you for improving the documentation!
I created #239 to take care of the developer's environment regarding developing documentation.
Mkdocs. Covers both docs and website. Looks nicer. Still on netlify.