Automattic / Automattic/wp-openid-connect-server

Improve documentation on configuring plugin

Open Beginner friendly
#93 2 comments 3 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
44
Forks
13
PR merge metrics
No merged PRs in 30d

Description

Docs are not too clear on how to configure the keys. We should mention specifically that they should be set in `wp-config.php`, and could also mention using `wp-cli` to set it.

Docs are also not too clear on how to set `oidc_clients`. It's suggested to use `functions.php`, which is not ideal because it's tied to the theme. We should probably suggest using a plugin (or probably even an mu-plugin) to configure the `oidc_clients`.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing documentation sections covering key configuration and oidc_clients setup. Update them to identify wp-config.php, mention wp-cli, and recommend a plugin or mu-plugin instead of functions.php; done means all three configuration paths are explained clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.