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.

Sign up for GitHub

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

IBX-9609: Strict validation #2666

Draft
wants to merge 22 commits into
base: master
Choose a base branch
from
+8 −2
Draft

IBX-9609: Strict validation #2666

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
279e62f
requirements.txt: Upgrade mkdocs
adriendupuis Feb 20, 2025
f8f28fd
requirements.txt: Upgrade Markdown
adriendupuis Feb 20, 2025
b52732d
Merge branch 'master' into IBX-9609-upgrade-mkdocs
adriendupuis Feb 24, 2025
f8323ad
Merge branch 'master' into IBX-9609-upgrade-mkdocs
adriendupuis Feb 24, 2025
7f4108a
IBX-9609: Upgrade all requirements (#2630)
adriendupuis Feb 25, 2025
4b5c803
Merge branch 'master' into IBX-9609-upgrade-mkdocs
adriendupuis Mar 5, 2025
1476097
Merge branch 'master' into IBX-9609-upgrade-mkdocs
adriendupuis Mar 5, 2025
2fe68f6
.readthedocs.yml: Upgrade python & pip (#2653)
adriendupuis Mar 5, 2025
2236bf1
Merge branch 'master' into IBX-9609-upgrade-mkdocs
adriendupuis Mar 6, 2025
e6f1970
Merge branch 'master' into IBX-9609-upgrade-mkdocs
adriendupuis Mar 6, 2025
374ff93
Test `absolute_links: relative_to_docs`
adriendupuis Mar 7, 2025
1bbfb69
Revert "Test `absolute_links: relative_to_docs`"
adriendupuis Mar 7, 2025
f020b83
mkdocs: `absolute_links: relative_to_docs`
adriendupuis Mar 7, 2025
ed04788
mkdocs: increase unrecognized_links strictness
adriendupuis Mar 7, 2025
c23b07a
mkdocs: plan to increase omitted_files strictness
adriendupuis Mar 7, 2025
e044bcf
mkdocs: Plan to increase anchors strictness
adriendupuis Mar 7, 2025
e85e040
IBX-9609: Upgrade mkdocs (#2627)
adriendupuis Mar 9, 2025
95b4a93
Merge branch 'master' into IBX-9609-strict-validation
adriendupuis Mar 9, 2025
48e85a8
mkdocs.yml: Fix validation
adriendupuis Mar 9, 2025
d9cdbf1
Rollback docs/api/php_api/php_api.md
adriendupuis Mar 10, 2025
9a7a1ff
mkdocs.yml: ignore legacy_recommendation_api.md
adriendupuis Mar 13, 2025
8c63bda
Update mkdocs.yml
adriendupuis Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/php_api/php_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# PHP API

The [public PHP API](../php_api_reference/) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code.
The [public PHP API](/api/php_api/php_api_reference/index.html) enables you to interact with [[= product_name =]]'s Repository and content model from your PHP code.

Check warning on line 8 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L8 

[Ibexa.DontCapitalize] Don't capitalize 'Repository' if inside the sentence.
Raw output 
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Repository' if inside the sentence.", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 8, "column": 117}}}, "severity": "WARNING"}

You can use it to create, read, update, manage, and delete all objects available in [[= product_name =]], namely content and related objects such as sections, locations, content types, or languages.

Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ site_url: https://doc.ibexa.co/en/latest/
copyright: "Copyright 1999-2024 Ibexa AS and others"
validation:
links:
# omitted_files: warn # TODO: Remove docs/personalization/legacy_recommendation_api.md
absolute_links: relative_to_docs
unrecognized_links: warn
# anchors: warn # TODO: Fix IBX-9578
not_in_nav: |
search_results.md
/snippets/*
nav:
- Ibexa Developer Documentation: index.md
- Ibexa DXP editions:
Expand Down