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.

Sign up for GitHub

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

Jump to bottom

Review and update documentation for Troubleshooting #328

Open
osopardo1 opened this issue May 9, 2024 · 0 comments
Open

Review and update documentation for Troubleshooting #328

osopardo1 opened this issue May 9, 2024 · 0 comments
Labels
type: documentation Improvements or additions to documentation

Comments

@osopardo1
Copy link
Member

Some multiple factors and parameters may influence writing and reading behavior, and right now there is no easy way to find which tuning is necessary. It takes a combination of knowledge of OTreeAlgorithm, QbeastFormat and AdvancedConfiguration to resolve some quick errors.

The FAQ.md should be:

  • Renamed to Troubleshooting.md
  • Send it to the main repo page.
  • Be linked from the Readme.
  • Contain more information about how to Troubleshoot Qbeast Spark.
@osopardo1 osopardo1 added the type: documentation Improvements or additions to documentation label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@osopardo1