Skip to content

chore: DRAFT PR to add HWP Toolkit#359

Closed
colinmurphy wants to merge 7 commits into
mainfrom
poc-hwp-toolkit-docs-integration
Closed

chore: DRAFT PR to add HWP Toolkit#359
colinmurphy wants to merge 7 commits into
mainfrom
poc-hwp-toolkit-docs-integration

Conversation

@colinmurphy

Copy link
Copy Markdown
Member

Note

This is a POC branch to see how feasible it is to add HWP Toolkit to Faust docs site as part of the roadmap - https://github.com/wpengine/faustjs/blob/canary/ROADMAP.md

Introduces a new /toolkit/ route for documentation, updates navigation and shared logic to support both Docs and Toolkit sections, and refactors data fetching utilities to handle multiple doc sources. This enables serving and navigating documentation from the 'hwptoolkit' repository alongside the existing FaustJS docs.
Adds logic to determine the correct file append (e.g., 'index.md' or other) for toolkit documentation routes based on navigation data. Updates docUrlFromSlug and getParsedDoc to accept an append parameter, and introduces findAppendForRoute to select the appropriate file for each route.
@headless-platform-by-wp-engine

Copy link
Copy Markdown

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-poc-hwp-toolkit-docs-integration https://hp…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

Copy link
Copy Markdown

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-poc-hwp-toolkit-docs-integration https://hp…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

Copy link
Copy Markdown

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-poc-hwp-toolkit-docs-integration https://hp…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

Copy link
Copy Markdown

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-poc-hwp-toolkit-docs-integration https://hp…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

Copy link
Copy Markdown

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-poc-hwp-toolkit-docs-integration https://hp…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@colinmurphy

Copy link
Copy Markdown
Member Author

Closing PR as we will be migrating docs to developer platform docs. Not sure if @Fran-A-Dev or @moonmeister some of the code here for fetching files locally might be useful in future if you need it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant