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

Fix docs linting issues #350

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Fix docs linting issues #350

merged 1 commit into from
Nov 25, 2024

Conversation

gsteel
Copy link
Member

@gsteel gsteel commented Nov 25, 2024

Q A
Documentation yes
QA yes

@gsteel gsteel added Documentation QA Quality assurance tasks such as static analysis improvements labels Nov 25, 2024
@gsteel gsteel added this to the 4.1.0 milestone Nov 25, 2024
@gsteel gsteel requested a review from froschdesign November 25, 2024 11:30
@gsteel
Copy link
Member Author

gsteel commented Nov 25, 2024

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

@froschdesign
Copy link
Member

@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.

Signed-off-by: George Steel <[email protected]>
@froschdesign
Copy link
Member

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

## Learn
<ul class="list-group list-group-flush">
<li class="list-group-item">
<a href="/laminas-cache/v3/application-integration/usage-in-a-laminas-mvc-application/">Usage in a laminas-mvc application</a>
</li>
</ul>

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

@gsteel
Copy link
Member Author

gsteel commented Nov 25, 2024

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

@gsteel gsteel self-assigned this Nov 25, 2024
@gsteel gsteel merged commit aaf298a into laminas:4.1.x Nov 25, 2024
11 checks passed
@gsteel gsteel deleted the doc-fixes branch November 25, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation QA Quality assurance tasks such as static analysis improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants