Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website: Graphile Engine 4.0 docs migrated to build.graphile.org #2309

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

jemgillam
Copy link
Contributor

@jemgillam jemgillam commented Jan 13, 2025

Description

I noticed we have yet to migrate over the Graphile Engine docs. This is needed before we refresh graphile.org.

The docs on build.graphile.org are now versioned. "Current" is 4.x and "Next" is the new version. This reflects how postgraphile.org is currently.

Almost all of the content is a straight copy from https://www.graphile.org/graphile-build/ with exceptions:

To fix

There's two things I think would be nice to fix, but this can be reviewed and merged without:

  1. There are now two dropdowns for the versioning. One for each project (graphile-build and graphile-build-pg). I think it would be nice to put in vertical dividers in the nav bar between the items, but apparently this isn't possible with docusaurus as it only allows specific items in the navbar. Perhaps it can be done with CSS borders. Another hacky option which I think is too overkill is detailed here: https://stackoverflow.com/questions/69173994/docusaurus-2-how-to-add-custom-react-component-in-navbar

Screenshot 2025-01-13 at 17 17 27

  1. Our old site has a neat solution to tidy up the table of contents where arguments in brackets are replaced with .... It would be nice to replicate this:

OLD
Screenshot 2025-01-13 at 17 18 11

NEW
Screenshot 2025-01-13 at 17 17 59

  1. I've noticed postgraphile.org has nice styling for the highlighted line in a code block, I'd like to replicate that here.

Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: 32cd214

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🌳 Triage
Development

Successfully merging this pull request may close these issues.

1 participant