mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-10-02 10:45:05 -04:00
DOCS: skill updates, WIFICANARY updates
This commit is contained in:
1 parent
591b1fadbe
commit
28eced2a25
9 files changed
+27
-9
No files matched your search
@@ -41,6 +41,7 @@ Before concluding a plugin has no attribution to record, grep its script for a c
|
||||
- `TBC` or similarly empty content, especially for a prominent feature.
|
||||
- Duplicate or orphaned sections (e.g. two `### Usage` headings) - usually a merge/edit artifact.
|
||||
- Sibling non-README files (a provider-specific sub-guide, a translated `README_<LANG>.md`) that aren't linked from the plugin's own `README.md` - `docs/gen_plugin_pages.py` generates a page for every `*.md` in the plugin folder, but only reachable if something links to it.
|
||||
- A table (or any multi-line block) indented under a bullet as that list item's continuation. GitHub's renderer tolerates this, but the docs site (`mkdocs`, Python-Markdown) terminates the list right there - the table and everything after it fall out as orphaned paragraphs, and the *next* bullet renders as a literal `-`-prefixed line of text instead of a list item. Looks fine in the PR diff on GitHub, breaks only once published. Fix: de-nest it - end the bullet's text, blank line, then the table/block as top-level (unindented) content, blank line, then resume the list as a fresh block.
|
||||
|
||||
## Reference
|
||||
|
||||
|
||||
@@ -9,6 +9,8 @@ description: Read when reviewing a plugin PR or auditing an existing plugin scri
|
||||
|
||||
This is a reviewer-facing checklist, complementary to [[plugin-development]] (which is author-facing). For `config.json` conventions already covered there and mechanically checked by `test/plugins/test_plugin_conventions.py`, defer to that skill's "Before Opening a PR" checklist and run that test rather than re-deriving the list here - it grows as new checks get added, so a copy of it here would go stale.
|
||||
|
||||
If the PR adds or changes `server/plugins/<code_name>/README.md`, also apply [[plugin-readme]] - none of the checks below touch README structure, "Other info" attribution, or markdown that only breaks once rendered on the docs site (e.g. a table nested inside a list item, which MkDocs' Python-Markdown parser terminates the list on - GitHub's renderer is more forgiving, so this passes a casual look at the PR diff and only breaks on the published page). A plugin PR without a reviewed README is only half-reviewed.
|
||||
|
||||
## The check this skill adds: no raw SQL in a plugin script
|
||||
|
||||
Plugin scripts write their results to `RESULT_FILE` via `plugin_helper.Plugin_Objects` — the framework inserts those rows into the DB. A plugin that also runs its own `SELECT`/`INSERT`/`UPDATE` (via `sqlite3` directly or `database.get_temp_db_connection()`) is bypassing that contract, usually to read existing data before deciding what to write.
|
||||
|
||||
Reference in new issue
Block a user