Skip to content

website: postgraphile.org: Version 4 docs sync up and refresh#2321

Merged
jemgillam merged 44 commits intomainfrom
postgraphile-sync
Feb 7, 2025
Merged

website: postgraphile.org: Version 4 docs sync up and refresh#2321
jemgillam merged 44 commits intomainfrom
postgraphile-sync

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
  • fix for automatic linking - it's just the use of a <span></span> tag in the middle of the not-link
  • 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 😊
  • extra languages for code highlighting
  • intro style, copied over to some of the 5.0 docs too
  • ... loads more I'm sure

@changeset-bot
Copy link

changeset-bot bot commented Jan 17, 2025

⚠️ No Changeset found

Latest commit: e6981b3

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

Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

Looking good! I've reviewed the first 33 files

@jemgillam jemgillam marked this pull request as ready for review February 6, 2025 11:59
@jemgillam
Copy link
Contributor Author

Seeing as you're half way through reviewing this, I've marked it as ready for review. Once merged I can do smaller editorial PRs

jemgillam and others added 8 commits February 7, 2025 11:12
Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
…er.md


Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
…er.md


Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
…er.md


Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
…er.md


Code review changes

Co-authored-by: Benjie <benjie@jemjie.com>
@jemgillam jemgillam merged commit 6fa82ed into main Feb 7, 2025
42 checks passed
@jemgillam jemgillam deleted the postgraphile-sync branch February 7, 2025 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants