Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation section added with additional links #212

Closed
wants to merge 1 commit into from

Conversation

xnan-dev
Copy link

@xnan-dev xnan-dev commented Aug 15, 2022

Signed-off-by: Hernán Rancati [email protected]

Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no

Description

Improved readability in home readme: added a documentation section, links to quick start, adapters and full docs. Also, link to PSR-11 specs.

Improved readability in home readme: added a documentation section, links to quick start, adapters and full docs.

Signed-off-by: Hernán Rancati <[email protected]>
@@ -22,12 +22,19 @@
is able to cache different patterns (class, object, output, etc) using different
storage adapters (DB, File, Memcache, etc).

## Documentation

- [Quickstart and introduction to laminas](https://docs.laminas.dev/laminas-cache/v3/pattern/intro/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@froschdesign is it somehow possible to have some kind of latest path so we do not need to update the README whenever we create new majors?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@boesing
Sorry for the delay, I am on holiday.

There is no special path like latest therefore we need an automatic link checker before to prevent wrong or outdated links.
See: laminas/laminas-continuous-integration-action#34

@boesing
Copy link
Member

boesing commented Aug 16, 2022

Nice, thanks!
Would love to get some feedback from @froschdesign. Especially regarding the versionized links.

@froschdesign
Copy link
Member

@xnan-dev
The idea of reworking the readme file has been around for a while, but it still needs some discussion and also more precise planning, because in the end the readme files in all repositories have to have the same structure. And if we add new links to all readme files of Laminas, Mezzio or API Tools then we need an automatic link checker before.

Please create an issues report in the repository for the documentation for this topic.
Thanks in advance! 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants