search

laminas / laminas-cache

Caching implementation with a variety of storage options, as well as codified caching strategies for callbacks, classes, and output
https://docs.laminas.dev/laminas-cache/
BSD 3-Clause "New" or "Revised" License
103 stars 52 forks source link

Fix docs linting issues #350

Closed gsteel closed 4 days ago

gsteel commented 4 days ago
Q A
Documentation yes
QA yes
gsteel commented 4 days ago

@froschdesign Can you advise what to do about /docs/index.md - can it be deleted?

froschdesign commented 4 days ago

@gsteel

…can it be deleted?

Unfortunately not, because MkDocs produce an error if the file is listed in the navigation but not in the file system. And the navigation entry is needed, otherwise the homepage is missing.

froschdesign commented 4 days ago

And here we have special case because the content of index.md is used for the homepage instead of auto-generated:

https://github.com/laminas/laminas-cache/blob/f25e67a99311bbcfeeda6f8167419f3518a1e691/docs/book/index.md?plain=1#L9-L15

https://docs.laminas.dev/laminas-cache/#learn

gsteel commented 4 days ago

I've just disabled linting for index.md - that OK?