Add usage documentation to the NACC settings page#27
Merged
Conversation
Surface how to use the plugin directly on the Settings → NACC admin page (closes #26): - "How to Use" section explaining the [nacc] shortcode and that the settings on the page are the site-wide defaults. - Shortcode attribute table (theme, language, layout, special) mirroring README.md, noting attributes override the saved defaults per-instance. - One-line description of each control (Theme / Language / Layout / Show Special Keytags). - Link to the bundled nacc2/README.md for standalone (non-WordPress) usage. Bump version to 6.0.2 and add a readme.txt changelog entry. Help copy is mirrored from README.md / nacc2/README.md; escaping matches the existing draw_settings() conventions (static markup + esc_url for the README link). 🐦⬛ Generated with Claude Code, orchestrated by Crow Co-Authored-By: Claude <noreply@anthropic.com> Crow-Session: 065EC34B-D2C2-46A1-899B-EDFE29AEA7CD
pjaudiomv
approved these changes
Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #26
What
Adds a How to Use help section to the Settings → NACC admin page (
draw_settings()), so new admins learn to place the[nacc]shortcode without leaving the dashboard.The section covers:
[nacc]to any page/post; the settings on the page are the site-wide defaults.theme/language/layout/specialmirroringREADME.md, noting each attribute overrides the saved default per-instance.nacc2/README.md(viaplugins_url()).Copy is mirrored from the existing source of truth (
README.md/nacc2/README.md) rather than reworded. Output escaping follows the existingdraw_settings()conventions: static admin markup plusesc_url()for the README link.make lint(phpcs, WordPress-Core) passes clean.Scope
Change is limited to the settings-page help copy and the
readme.txt/ version bump. No keytag render or specialty-toggle behavior is touched — that's #24/#25.Per the ticket, the version bump +
readme.txtchangelog is meant to be done once for the combined #24/#25/#26 set. Since #24 and #25 have no PRs yet, this PR lands #26 alone with the smallest correct bump:6.0.1 → 6.0.2(plugin header +Stable tag) and one changelog entry.If #24/#25 land in the same release, please fold this bump into the combined one rather than double-bumping — the
6.0.2changelog entry / Stable tag here can be merged/superseded as needed. Flagging so merge order can be managed.