search

dbrgn / tealdeer

A very fast implementation of tldr in Rust.
https://dbrgn.github.io/tealdeer/
Apache License 2.0
4.06k stars 123 forks source link

Documentation out of date with release #363

Closed EoinFarrell closed 4 months ago

EoinFarrell commented 4 months ago

Documentation states that custom pages should use the naming scheme xxx.page.md, links:

The naming scheme was changed from xx.page to xxx.page.md in #322, merged on the 2024-02-15. But the latest release, v1.6.1 is from 2022-10-24.

This discrepency leads to problems, as if you follow the documentation and use the xxx.page.md, your custom pages will not be found.

New release is required to align main and release version.

EoinFarrell commented 4 months ago

There could be other problems/descrepencies between the latest release and the latest docs, but this is the only one I have so far come across since starting to use tealdeer. Issues such as #356 could be related to this also, if other users are thinking they are using an out of date version.

niklasmohrin commented 4 months ago

Thanks for the report! We are already tracking this problem in #358, so I am going to close this as duplicate