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

doc/doxygen: remove default value for search form #20681

Merged
merged 1 commit into from
May 21, 2024

Conversation

mguetschow
Copy link
Contributor

@mguetschow mguetschow commented May 21, 2024

Contribution description

The search input field on doc.riot-os-org is prefilled with value="Search", instead of only using the HTML placeholder attribute. I think this was not the case until some recent doxygen version bump, but I am not sure since the corresponding JS-code has been part of the repo for seven years.

Testing procedure

Open https://doc.riot-os.org on Firefox or Chrome, see that the search field is prefilled.

Compare to the CI generated doxygen, which should only use "Search" as placeholder value: https://ci.riot-os.org/results/534d783017ac45f0a2d217c67b876c9f/doc-preview/

Issues/PRs references

Pinging @miri64 as the original author of the js-code.

@github-actions github-actions bot added the Area: doc Area: Documentation label May 21, 2024
@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label May 21, 2024
@benpicco benpicco requested a review from miri64 May 21, 2024 13:15
@riot-ci
Copy link

riot-ci commented May 21, 2024

Murdock results

✔️ PASSED

154e0bd doc/doxygen: remove default value for search form

Success Failures Total Runtime
1 0 1 01m:07s

Artifacts

Copy link
Member

@miri64 miri64 left a comment

Choose a reason for hiding this comment

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

LGTM. Why the value was set, I am not sure anymore. As you said, I implemented this 7 years ago and did not touch it much. Most likely, there was some faulty behavior in Doxygen's HTML output.

@miri64 miri64 enabled auto-merge May 21, 2024 13:19
@miri64 miri64 added this pull request to the merge queue May 21, 2024
Merged via the queue into RIOT-OS:master with commit aef06f4 May 21, 2024
27 checks passed
@mguetschow mguetschow deleted the docs-search-value branch May 21, 2024 14:21
@mguetschow
Copy link
Contributor Author

Thanks!

@mguetschow mguetschow added this to the Release 2024.07 milestone Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants