Skip to content

fix[faustwp]: (#2043) update settings page documentation links#2319

Open
latenighthackathon wants to merge 1 commit intowpengine:canaryfrom
latenighthackathon:fix/faustwp-settings-page-links
Open

fix[faustwp]: (#2043) update settings page documentation links#2319
latenighthackathon wants to merge 1 commit intowpengine:canaryfrom
latenighthackathon:fix/faustwp-settings-page-links

Conversation

@latenighthackathon
Copy link
Copy Markdown

Description

The FaustWP settings page contains 8 links to faustjs.org using legacy URL patterns (/guide/*, /docs/next/*, /docs/faustwp/*) that rely on redirects to reach the current documentation structure. This updates all links to point directly to the current URLs.

Link mapping

Old URL New URL
/docs/getting-started /docs/how-to/basic-setup
/docs/next/getting-started /docs/how-to/basic-setup
/docs/faustwp/settings /docs/how-to/basic-setup
/guide/how-to-setup-post-and-page-previews /docs/how-to/post-previews
/guide/how-to-use-the-faust-example-project /docs/tutorial/learn-faust
/tutorial/get-started-with-faust /docs/tutorial/learn-faust
/guide/how-to-use-apollo-in-faust /docs/how-to/query-data-in-the-browser
/guide/how-to-handle-authentication /docs/how-to/authentication

All replacement URLs verified against the live faustjs.org docs site.

Related Issues

Closes #2043

Testing

Confirm the issue (before the fix)

1. Check for legacy link patterns in settings files:

grep -n "/guide/\|/docs/next/\|/docs/faustwp/" plugins/faustwp/includes/settings/callbacks.php plugins/faustwp/includes/settings/views/headless-settings.php
# Expected on canary: 6+ matches using old URL patterns

Confirm the fix

2. Verify no legacy patterns remain:

grep -n "/guide/\|/docs/next/\|/docs/faustwp/" plugins/faustwp/includes/settings/callbacks.php plugins/faustwp/includes/settings/views/headless-settings.php
# Expected: no output

3. Verify all links now use current docs structure:

grep -n "faustjs.org" plugins/faustwp/includes/settings/callbacks.php plugins/faustwp/includes/settings/views/headless-settings.php
# Expected: all links use /docs/how-to/* or /docs/tutorial/* patterns

Run the test suites

phpcs:

cd plugins/faustwp && composer install && composer phpcs

JS tests:

npm install && npm run build && npm run test

The FaustWP settings page contains 8 links to faustjs.org using
legacy URL patterns (/guide/*, /docs/next/*, /docs/faustwp/*) that
rely on redirects to reach the current documentation.

Update all links to use the current URL structure:
- /docs/getting-started → /docs/how-to/basic-setup
- /docs/next/getting-started → /docs/how-to/basic-setup
- /docs/faustwp/settings → /docs/how-to/basic-setup
- /guide/how-to-setup-post-and-page-previews → /docs/how-to/post-previews
- /guide/how-to-use-the-faust-example-project → /docs/tutorial/learn-faust
- /tutorial/get-started-with-faust → /docs/tutorial/learn-faust
- /guide/how-to-use-apollo-in-faust → /docs/how-to/query-data-in-the-browser
- /guide/how-to-handle-authentication → /docs/how-to/authentication

Closes wpengine#2043
@latenighthackathon latenighthackathon requested a review from a team as a code owner April 3, 2026 05:36
@headless-platform-by-wp-engine
Copy link
Copy Markdown

Currently, we do not support the creation of preview deployments based on changes coming from forked repositories.
Learn more about preview environments in our documentation.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 3, 2026

🦋 Changeset detected

Latest commit: 543f8e1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@faustwp/wordpress-plugin Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-project-automation github-project-automation bot moved this to 🆕 Backlog in Headless OSS Apr 3, 2026
@ahuseyn ahuseyn moved this from 🆕 Backlog to 👀 In review in Headless OSS Apr 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

Updating links for docs in FaustWP settings page

2 participants