xcode-man-pages icon indicating copy to clipboard operation
xcode-man-pages copied to clipboard

Versioned URLs

Open stefanschmidt opened this issue 2 years ago • 3 comments

Currently the man pages are served without any versioning in the URL. e.g. https://keith.github.io/xcode-man-pages/ls.1.html

Somebody might write about something specific to the currently served Xcode version and link to a man page. When a new version of the man pages is published on the website the link then points to the new version instead of the one that the link originally pointed to.

Or somebody might be implementing a program and wants to casually check for compatibility of a command line option or type signature across macOS versions (possibly using diffing tools on earlier repository revisions as a systematic next step).

Thus it seems meaningful both for link stability and researching to have versioned URLs. The most straightforward approach might be to include the Xcode version or the build number in the URL. e.g. https://keith.github.io/xcode-man-pages/13.3/ls.1.html or https://keith.github.io/xcode-man-pages/13E113/ls.1.html

Another approach might be to serve the last available Xcode release for a macOS version and include the macOS version in the URL. I'm not sure though if that actually would be meaningful. e.g. https://keith.github.io/xcode-man-pages/macOS12/ls.1.html

For simplicity and brevity it might be good to keep the current URL naming convention and just provide the versioned URLs as additional access method. Talking about brevity, if the project turns out to be popular, it might be worth considering moving it to a shorter domain (something along the lines of xcman.io/ls.1 for the latest Xcode release).

Anyway, thanks for offering this usable, readable and up-to-date website!

stefanschmidt avatar Apr 22 '22 20:04 stefanschmidt