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

Search function improvement in online manual #793

Open
hooyuser opened this issue Jan 13, 2025 · 0 comments
Open

Search function improvement in online manual #793

hooyuser opened this issue Jan 13, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hooyuser
Copy link

hooyuser commented Jan 13, 2025

Description
The search function in the online manual needs improvement. I attempted to search for the term debug in the API section to find documentation on how to turn on debugging, but no results were returned. However, the relevant information exists in the API documentation at Canvas Debug Parameter.

Steps to Reproduce

  • Go to the online manual.
  • Use the search box and type debug.
  • Observe that no results are displayed, even though the debug parameter of canvas is documented.

Expected Behavior
When searching for debug in the search box, I expect relevant API documentation, such as the Canvas Debug Parameter, to appear in the search results.

Suggestions for Improvement
Ensure that all API keywords in the API section, are indexed correctly for the search function.

@johannes-wolf johannes-wolf added the documentation Improvements or additions to documentation label Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants