Skip to content

Conversation

@moonmeister
Copy link
Member

@moonmeister moonmeister commented Mar 12, 2025

move mdx docs to the faustjs repo.

Tasks

  • move docs and import from GH APIs
    • Based on my original work in wpgrpahql.com
    • modified docs to me MD as we didn't need the full MDX power
    • moved to frontmatter from mdx style exports
    • Moved Doc Docs from Readme to faustjs repo
    • Updated Readme to show how and where various aspects of the site can be edited for content.
    • Images are no longer using Next Image. This isn't ideal, but it was proving difficult to fix this. We can revisit this soon. Though WPGraphQL has survived just fine.
  • Update smart search docs loader to fetch remote docs
    • Fetched Docs from GitHub
    • Correctly paginated existing docs query before deletion
    • simplified to deleting ALL existing mdx_docs from smart search instead of trying to diff
    • moved away from webpack command as it wasn't doing anything for us to standard CLI, set to execute only on
    • headless platform and added some test commands.
    • simplified parsing to use unified system like actual doc rendering does so only text is indexed
  • update TOC to be at build time
    • Found a plugin to help with this
    • Had to modify some variable usage after moving to a plugin for this from the custom implementation
  • merge docs on faustjs repo and update branch noted here
  • "Edit this doc on GitHub" links
    • updated styling and wording
    • made dynamic to generate a link from repo consts like for fetching content in the first place
  • Fixed a few bugs with next/prev page buttons, and in the breadcrumbs
  • Tweaked the Link component to correctly size the icon based on font size

Companion to wpengine/faustjs#2046

@moonmeister moonmeister marked this pull request as draft March 12, 2025 02:10
@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs https://hi…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs N/A ❌ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs N/A ❌ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs N/A ❌ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs N/A ❌ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs N/A ❌ (logs)

Learn more about preview environments in our documentation.

@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs https://hi…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@moonmeister moonmeister marked this pull request as ready for review March 13, 2025 01:32
@moonmeister moonmeister requested a review from colinmurphy March 13, 2025 01:32
@moonmeister moonmeister marked this pull request as draft March 13, 2025 01:35
@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs https://hi…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@moonmeister moonmeister marked this pull request as ready for review March 13, 2025 14:21
@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs https://hi…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@moonmeister moonmeister requested a review from Fran-A-Dev March 13, 2025 14:25
@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs https://hi…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@moonmeister moonmeister requested a review from a team March 13, 2025 15:32
@headless-platform-by-wp-engine

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

App Environment URL Build
faustjs.org preview-env-remote-docs https://hi…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

@josephfusco
Copy link
Member

@moonmeister There are quite a few changes here - what’s the best way to test this? Are there specific areas of the site to focus on?

@moonmeister
Copy link
Member Author

@josephfusco probably clicking around the new site. I gave a pretty comprehensive list of things changed. Maybe visually verifying things I touched are working.

Copy link
Member

@josephfusco josephfusco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm seeing some issues with the blog posts in the latest preview environment - https://hicuy553ynd6o7orxs95na6l4.js.wpenginepowered.com/blog/taking-customer-inspired-up-a-level/

CleanShot 2025-03-13 at 12 50 26@2x

Copy link
Contributor

@Fran-A-Dev Fran-A-Dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks good to me. I clicked around the site on the files you migrated and changed and tried the Edit this doc in GH feature and that worked along with search.

@Fran-A-Dev
Copy link
Contributor

I'm seeing some issues with the blog posts in the latest preview environment - https://hicuy553ynd6o7orxs95na6l4.js.wpenginepowered.com/blog/taking-customer-inspired-up-a-level/

CleanShot 2025-03-13 at 12 50 26@2x

@josephfusco let me try again, it is fine on mine

@moonmeister
Copy link
Member Author

@josephfusco @Fran-A-Dev Just fixed it. Was a server issue. content-blocks got disabled.

Copy link
Member

@josephfusco josephfusco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, it's working now!

@Fran-A-Dev
Copy link
Contributor

Cool, it's working now!

Yup works for me too @moonmeister !!! Stoked

Copy link
Member

@colinmurphy colinmurphy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀 🚀 🚀 ❤️

I setup this up locally and compared to the current site and I couldn't find any differences.

@moonmeister
Copy link
Member Author

Thanks all. Will merge Monday morning.

@moonmeister moonmeister added this pull request to the merge queue Mar 17, 2025
@moonmeister moonmeister removed this pull request from the merge queue due to a manual request Mar 17, 2025
@moonmeister moonmeister added this pull request to the merge queue Mar 17, 2025
@moonmeister moonmeister removed this pull request from the merge queue due to the queue being cleared Mar 17, 2025
@moonmeister moonmeister merged commit d303ba3 into main Mar 17, 2025
4 checks passed
@moonmeister moonmeister deleted the remote-docs branch March 17, 2025 15:18
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.

5 participants