Skip to content

Link to the WordPress.org plugin page in README and docs #66

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.

Sign up for GitHub

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

Merged
soham2008xyz merged 1 commit into from
Nov 2, 2026
Merged

Link to the WordPress.org plugin page in README and docs #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

WordPress plugin (slug `renderbit-faq-structured-data`, published on WordPress.org) that manages FAQs as a `rfsd_faq` custom post type (`RFSD_POST_TYPE`) and prints schema.org `FAQPage` JSON-LD in `wp_head` on the singular posts/pages each FAQ is mapped to. Procedural PHP, every function prefixed `rfsd_`; no build step and no runtime Composer dependencies. Supports WordPress 6.5+ and PHP 7.2+, so don't use syntax newer than PHP 7.2 in shipped code.
WordPress plugin (slug `renderbit-faq-structured-data`, published on [WordPress.org](https://wordpress.org/plugins/renderbit-faq-structured-data/)) that manages FAQs as a `rfsd_faq` custom post type (`RFSD_POST_TYPE`) and prints schema.org `FAQPage` JSON-LD in `wp_head` on the singular posts/pages each FAQ is mapped to. Procedural PHP, every function prefixed `rfsd_`; no build step and no runtime Composer dependencies. Supports WordPress 6.5+ and PHP 7.2+, so don't use syntax newer than PHP 7.2 in shipped code.

## Commands

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Tests live in `tests/js`.

## Releasing

The plugin is published on WordPress.org as `renderbit-faq-structured-data`. The shipped files are whatever `git archive` produces, so `.gitattributes` decides what reaches both the release zip and WordPress.org SVN.
The plugin is published on WordPress.org as `renderbit-faq-structured-data` (https://wordpress.org/plugins/renderbit-faq-structured-data/). The shipped files are whatever `git archive` produces, so `.gitattributes` decides what reaches both the release zip and WordPress.org SVN.

1. Run `composer bump-patch` (or `bump-minor`, `bump-major`). It runs `bin/bump-version.php`, which sets the new version in `composer.json`, the `Version` header and `RFSD_VERSION` in `renderbit-faq-structured-data.php`, and `Stable tag` in `readme.txt`, then refreshes the `composer.lock` hash. Add a `readme.txt` changelog entry and bump `Tested up to` when needed.
2. Merge to `main`, then push a `vX.Y.Z` tag. `draft-release.yml` builds the zip and creates a draft GitHub release.
Expand Down
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Renderbit FAQ Structured Data

![WordPress Plugin](https://img.shields.io/badge/WordPress-Plugin-21759B?logo=wordpress&logoColor=fff)
[![WordPress Plugin](https://img.shields.io/badge/WordPress-Plugin-21759B?logo=wordpress&logoColor=fff)](https://wordpress.org/plugins/renderbit-faq-structured-data/)
![PHP](https://img.shields.io/badge/PHP-%E2%89%A5%207.2-777BB4?logo=php&logoColor=fff)
![MySQL](https://img.shields.io/badge/MySQL-Mapping%20Table-4479A1?logo=mysql&logoColor=fff)
![WP-Cron](https://img.shields.io/badge/Background-WP--Cron%20Queue-orange)
Expand All @@ -23,7 +23,13 @@ A WordPress plugin to manage FAQ items as a custom post type (CPT) and inject FA

## Installation

1. Copy the plugin folder to your WordPress `wp-content/plugins/` directory.
The plugin is available on WordPress.org: <https://wordpress.org/plugins/renderbit-faq-structured-data/>

**From the WordPress admin (recommended):** go to Plugins > Add New, search for "Renderbit FAQ Structured Data", then install and activate it.

**Manually:**

1. Download the plugin from [WordPress.org](https://wordpress.org/plugins/renderbit-faq-structured-data/) (or build a zip with `composer build-zip`) and copy the folder to your WordPress `wp-content/plugins/` directory.
2. Activate via the WordPress admin Plugins page.
3. On activation, the mapping table is created automatically.

Expand Down
Loading