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: Edit and clarify note about search plugin #314

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Conversation

prcr
Copy link
Owner

@prcr prcr commented Jan 16, 2024

No description provided.

Copy link

codeautopilot bot commented Jan 16, 2024

PR summary

The Pull Request involves a single documentation change in the README.md file. It clarifies the instructions regarding the addition of plugins to the mkdocs.yml file. Specifically, it updates a note to better explain that if a user did not previously have a plugins declaration in their mkdocs.yml file, they would need to explicitly add the search plugin upon adding new plugins. This is because MkDocs automatically enables the search plugin by default when no plugins declaration is present, but this implicit behavior changes once a plugins declaration is added.

Suggestion

No suggestions for improvement; the change is clear and enhances the documentation's clarity.

Disclaimer: This comment was entirely generated using AI. Be aware that the information provided may be incorrect.

Current plan usage: 0.00%

Have feedback or need help?
Discord
Documentation
support@codeautopilot.com

Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) (target: 80.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (748225c) 155 147 94.84%
Head commit (493c6fd) 155 (+0) 147 (+0) 94.84% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#314) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@prcr prcr merged commit c79b404 into main Jan 16, 2024
14 checks passed
@prcr prcr deleted the doc/clarify-search-plugin branch January 16, 2024 10:17
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.

1 participant