update Doc - Sticky FAQs Overview

[d0ubIeU]

The description has been updated to include the "Remove Sticky" button.

Summary by CodeRabbit

• Documentation

  • Clarified instructions for removing the sticky status from FAQs in the administration guide.

• Style

  • Minor formatting adjustment in sticky FAQs management code.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation is enhanced with clarification on removing sticky FAQ status, and a minor formatting adjustment is made to the sticky FAQs TypeScript module for consistency.

Changes

Cohort / File(s)	Summary
Documentation docs/administration.md	Added two sentences in section 5.2.3 explaining how to remove the "Important / Sticky" status using the pin icon, and clarifying that only the status is removed while the FAQ persists in the database.
Source Code Formatting phpmyfaq/admin/assets/src/content/stickyfaqs.ts	Added a blank line in the saveStatus function for improved readability between the CSRF check warning and subsequent alert handling.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• feat: add Remove-Sticky-Status Button in Sticky Faq Overview #3879: Modifies the same phpmyfaq/admin/assets/src/content/stickyfaqs.ts file, indicating related sticky FAQ functionality work.

Poem

🐰 A sticky note needs words so clear,

How to unpin when loose is near,

With formatting clean, the code shines bright,

Documentation and style, both right! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'update Doc - Sticky FAQs Overview' is directly related to the main change: adding documentation about removing sticky FAQs status.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 markdownlint-cli2 (0.18.1)

docs/administration.md

markdownlint-cli2 v0.18.1 (markdownlint v0.38.0)
Finding: docs/administration.md
Linting: 1 file(s)
Summary: 13 error(s)
Error: EACCES: permission denied, open '/markdownlint-cli2-results.json'
at async open (node:internal/fs/promises:640:25)
at async Object.writeFile (node:internal/fs/promises:1214:14)
at async Promise.all (index 0)
at async outputSummary (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:877:5)
at async main (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:1053:25)
at async file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2-bin.mjs:12:22 {
errno: -13,
code: 'EACCES',
syscall: 'open',
path: '/markdownlint-cli2-results.json'
}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}