Readme updates #409
Readme updates #409
Conversation
Locking these to a specific treeish will keep them stable. The links will have to be updated to refer to current docs as they are updated, but at least clicking a link won't point you to something that may not pertain at all to what you were expecting. Plus it was obviously already necessary to maintain updated links one way or another...
|
I still feel it would be preferable to base the doc links on a specific tree-ish so they're always highlighting the proper section (see the extended commit message: they may end up linking to stale documentation, but the alternative -- the current use of Maybe the whole issue of maintaining the links in this fashion is a yak shave 😄 Happy to rebase, but the call for help change is completely trivial. If you'd like to keep the locking to tree-ish approach then I'll keep that and update as appropriate when rebasing. |
|
@ches Ah, I see what you mean. You want to prevent the use case where somebody updates the docs and the highlighting shifts. I agree that's really annoying. Wish github just had some anchoring in the files for the highlighting api so I could joint point at the titles. I'm gonna think on this a bit, not sure I want to hard code a commit. |
|
Using the tag of latest release would be a reasonable compromise in ecosystems where people install packages from a versioned artifact repository, but alas, in Vim-land we all run everything from trunk, since the tools haven't yet coalesced to the ideal blend of the plugin managers and vim.org scripts archive... 😩 |
|
I think the best way would be to link to a release tag: |
|
Using now the tag for the current version, as suggested by @lucc Thanks 👏 |
Just some quick updates while I was looking at it.