Skip to content

Conversation

@rustprooflabs
Copy link
Owner

@rustprooflabs rustprooflabs commented Dec 13, 2025

Add docs for pgRouting 4

Reported via #408.

Release Notes

This PR splits routing examples based on pgRouting version to support the substantial change in pgRouting 4.0. The legacy instructions remain in a new subsection under routing making a space for the pgRouting 4 version. PgRouting 4.0 is a major upgrade so I don't expect people will jump to upgrade immediately.

image

The new pgRouting 4 procedures achieve the same results but tables and column are renamed. Much of the naming in the legacy example was driven by defaults/expectations in the pgRouting functions (that no longer exist). The goal of the renaming is to bring more clarity into the steps and data, hopefully improving the usability of the resulting structures, and making them easier to follow.

@rustprooflabs rustprooflabs added this to the 1.1.2 milestone Dec 13, 2025
@rustprooflabs rustprooflabs added the documentation Improvements or additions to documentation label Dec 13, 2025
@rustprooflabs rustprooflabs self-assigned this Dec 14, 2025
@rustprooflabs
Copy link
Owner Author

I have done a full run through using the D.C. routing example and validated I was able to get to parity with the original docs outcomes. The new instructions for pgRouting 4.0 might have some lingering typos/bugs, but I think getting basic docs out sooner than later is more important than perfect in this case.

I'll do more testing in the coming days/weeks, if anyone finds lingering issues feel free to open a new issue and reference this / #408. Thanks to @travishatiw for reporting!

@rustprooflabs rustprooflabs merged commit 80c5da5 into main Dec 14, 2025
4 checks passed
@rustprooflabs rustprooflabs deleted the fix-routing-docs-for-pgrouting4 branch December 14, 2025 16:58
@rustprooflabs rustprooflabs changed the title Set stage to add docs for pgRouting 4 Add docs for pgRouting 4 Dec 14, 2025
@rustprooflabs rustprooflabs added the enhancement New feature or request label Dec 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants