WordPress / WordPress/secure-custom-fields

Documentation revamp

Open
#158 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Project
Dominant language
PHP
Stars
131
Forks
64
Avg merge
10m
Merged PRs (30d)
1

Description

The current documentation for Secure Custom Fields (SCF), hosted in the project repository and on the WordPress developer documentation portal, faces several limitations that hinder its effectiveness for both developers and users. Key issues include missing documentation for fields, hooks, and advanced features, a lack of tutorials and visuals, broken links, and no clear entry point from the main WordPress developer documentation page.

A thorough audit is needed to identify these gaps, plan and prioritize next steps, and improvements.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Audit the Secure Custom Fields documentation in the project repository and on the WordPress developer documentation portal. Start by cataloguing gaps in field, hook, and advanced-feature coverage, tutorials, visuals, broken links, and the missing entry point from the main WordPress developer documentation page. Done means producing a prioritized plan for improvements.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.