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

Various docs tasks for consistency #271

Merged
merged 8 commits into from
Jan 9, 2024
Merged

Various docs tasks for consistency #271

merged 8 commits into from
Jan 9, 2024

Conversation

odunbar
Copy link
Collaborator

@odunbar odunbar commented Jan 2, 2024

Purpose

Closes #270
Closes #274

Content

  • Adds new Sinusoid example images and link into landing page, reorganize landing page.
    Landing page

  • Rearrange docs pages order (for cleaner contents)

  • Rename "Package-design/API for AbstractMCMC" -> "Sample"

  • Adds a user interface section into the "Sample" page at the top. Bumping other information further down
    Sample page

  • Adds recommended constructor for RF (nonseparable + low rank)
    RF page

Also

  • Updates testing to Julia v1.10, as pkg downloader would not work on 1.7.3 thus we could not merge PRs

  • I have read and checked the items on the review checklist.

Copy link

codecov bot commented Jan 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a621a04) 88.09% compared to head (c75ac05) 88.16%.
Report is 10 commits behind head on main.

❗ Current head c75ac05 differs from pull request most recent head ee17c5c. Consider uploading reports for the commit ee17c5c to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #271      +/-   ##
==========================================
+ Coverage   88.09%   88.16%   +0.07%     
==========================================
  Files           7        7              
  Lines        1134     1124      -10     
==========================================
- Hits          999      991       -8     
+ Misses        135      133       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@odunbar odunbar force-pushed the orad/docs-organize branch 2 times, most recently from 29f7218 to 3467140 Compare January 5, 2024 12:57
@odunbar odunbar changed the title added user interface section and made MCMC docs more consistent Various docs tasks for consistency Jan 5, 2024
format

reformat index table

add sinusoid figs in index

render img url

mix example into description

rearrange

add recommended construction

new subtitle
docs/src/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@lm2612 lm2612 left a comment

Choose a reason for hiding this comment

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

Looks really good, the side menu and sample page are much cleaner! only a few minor typos

docs/src/index.md Outdated Show resolved Hide resolved
docs/src/sample.md Outdated Show resolved Hide resolved
@odunbar
Copy link
Collaborator Author

odunbar commented Jan 9, 2024

Julia-wide registry issues are causing Buildkite to fail (and this cannot be fixed, whereas I can rerun test suites until they pass), I will bypass the buildkite to merge as we have not changed any of the files being run.

@odunbar odunbar merged commit c9c23fc into main Jan 9, 2024
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants