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

Issue 174: Add FAQ website section #181

Merged
merged 7 commits into from
Jul 22, 2024
Merged

Issue 174: Add FAQ website section #181

merged 7 commits into from
Jul 22, 2024

Conversation

athowes
Copy link
Collaborator

@athowes athowes commented Jul 19, 2024

Description

This draft PR will close #174.

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

This can be reviewed (modulo test passes).

I am having trouble checking it works locally because I get this error running pkgdown::build_site():

> pkgdown::build_site()
── Installing package epidist into temporary library ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
── Building pkgdown site for package epidist ───────────────────────────────────
Reading from: /Users/adamhowes/Documents/cfa/epidist
Writing to: /Users/adamhowes/Documents/cfa/epidist/docs
── Sitrep ──────────────────────────────────────────────────────────────────────
✔ URLs ok.
✔ Favicons ok.
✔ Open graph metadata ok.
✔ Articles metadata ok.
✔ Reference metadata ok.
── Initialising site ───────────────────────────────────────────────────────────
── Building home ───────────────────────────────────────────────────────────────
Reading LICENSE.md
Error: 
! in callr subprocess.
Caused by error in `readRDS(path)`:
! error reading from connection
ℹ See `$stdout` and `$stderr` for standard output and error.
Type .Last.error to see the more details.

@athowes athowes marked this pull request as ready for review July 19, 2024 10:01
@athowes athowes requested a review from seabbs July 19, 2024 10:02
seabbs
seabbs previously approved these changes Jul 19, 2024
Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

This looks really good. One question about the proposed workflow for users

vignettes/faq.Rmd Show resolved Hide resolved
@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

Before merge I think we should add a section saying how we want people to ask questions. How do we want? Issues? Something different?

Also we should add an issue to brainstorm more tips / FAQ.

@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

Also anyone have any idea what might be going on in my error (#181 (comment)) above?

@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

Added issue #182. Ready for re-review

@athowes athowes requested a review from seabbs July 19, 2024 13:18
@seabbs
Copy link
Contributor

seabbs commented Jul 19, 2024

No no idea. As it isn't happening in the CI I guess you have a different (and likely problematic) version of something vs what the CI sees

seabbs
seabbs previously approved these changes Jul 19, 2024
@seabbs
Copy link
Contributor

seabbs commented Jul 19, 2024

I'm a bit confused why this runs with bayesplot being present given we don't have it as a suggests:

roxyglobals

@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

I'm a bit confused

Hmm yeah good point. Is it that it's imported by something?

@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

No no idea. As it isn't happening in the CI I guess you have a different (and likely problematic) version of something vs what the CI sees

Yeah it was a bad version of httr2 I found.

@athowes
Copy link
Collaborator Author

athowes commented Jul 19, 2024

Yeah brms imports bayesplot

@seabbs seabbs enabled auto-merge (squash) July 22, 2024 10:23
@seabbs seabbs merged commit 117b058 into main Jul 22, 2024
8 checks passed
@seabbs seabbs deleted the faq-section branch July 22, 2024 11:04
seabbs pushed a commit that referenced this pull request Jan 10, 2025
* Add navbar structure

* Add FAQ template

* First written version of FAQ

* Lint package

* Add TOC, add how to ask a question, add production code folded

* Add explicit bayesplot to imports

* Code folding doesn't work in the website at the moment

Former-commit-id: d00ce83d55b3ee9eaea56ea6441dcd2703764489 [formerly bcbea763967d07eff1b0661316d64e9a6b6c63f7]
Former-commit-id: c21b5c4da2ca9d8d20e2dd6f74e36bd178f8593e
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.

Create FAQ or tips section
2 participants