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: postgraphile.org: Version 4 docs sync up and refresh #2321

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

jemgillam
Copy link
Contributor

@jemgillam jemgillam commented Jan 17, 2025

Description

Here I finish the Version 4 docs, ready to take them off of graphile.org.

This can't be merged until #2309 is live as it links to versioned docs on build.graphile.org which aren't live yet.

This PR includes

  • utilize :::note and similar boxes
  • fixing tailing slashes in URLs
  • styling for <tt> tag when links are incorrectly automatically picked up by docusaurus
  • remove unneeded front matter
  • improve use of headings - <h5> doesn't really work as an anchor or style
  • table of contents autogeneration on the applicable guide pages
  • some Americanization when I spotted it
  • fixes to anchor links within a page
  • add and fix images in documentation pages
  • fixes to titles in the side bar
    • This is done by the side bar title being in the front matter, and the longer title displayed on the page being in a <h1>
    • This tidies up the side bar rather nicely, most items in the sidebar are a lot shorter and mirror what is on graphile.org 😊
  • ... loads more I'm sure

Copy link

changeset-bot bot commented Jan 17, 2025

⚠️ No Changeset found

Latest commit: 4be747c

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