Add FAQ section to improve user guidance #608
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new FAQ section to the Turing.jl website and updates the navigation menu to include a link to it.
- Added a “FAQ” entry in the site navigation
- Created
faq/index.qmdwith a set of common Q&A on using Turing.jl
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| _quarto.yml | Inserted a navigation entry for the FAQ |
| faq/index.qmd | Added FAQ page with detailed user guidance |
Comments suppressed due to low confidence (1)
_quarto.yml:27
- Indentation of the new navigation entry does not match the surrounding items and could break the YAML. Align the
- href: faq/and itstext:line with the other menu entries.
- href: faq/
| - [Troubleshooting Guide](../usage/troubleshooting/) - common errors and their solutions | ||
| - For more advanced debugging, DynamicPPL provides `DynamicPPL.DebugUtils` for inspecting model internals | ||
|
|
||
| ## What are the main differences between Turing vs BUGS vs Stan syntax? |
There was a problem hiding this comment.
[nitpick] The phrasing “differences between Turing vs BUGS vs Stan” is awkward. Consider rewording to “differences between Turing, BUGS, and Stan syntax.”
Suggested change
| ## What are the main differences between Turing vs BUGS vs Stan syntax? | |
| ## What are the main differences between Turing, BUGS, and Stan syntax? |
Copilot uses AI. Check for mistakes.
9 tasks
|
Preview the changes: https://turinglang.org/docs/pr-previews/608 |
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.
This pull request adds a new FAQ section to the Turing.jl website and updates the navigation menu to include a link to the FAQ page. The FAQ section provides answers to common questions about using Turing.jl, covering topics such as random variables, implementing samplers, parallelism, debugging, syntax differences, automatic differentiation backends, and performance issues.
Website Navigation Update:
_quarto.yml: Added a new link to the FAQ page in the website's navigation menu.FAQ Section Addition:
faq/index.qmd: Created a new FAQ page with detailed answers to common questions about Turing.jl. Topics include variable treatment, sampler implementation, parallelism, type stability, debugging, syntax differences, automatic differentiation backends, and performance debugging.Relevant Issues: