Skip to content

Added Markdownlint - #419

Merged
mnocon merged 4 commits into
5.0from
add-markdownlint
Jul 29, 2026
Merged

Added Markdownlint#419
mnocon merged 4 commits into
5.0from
add-markdownlint

Conversation

@mnocon

@mnocon mnocon commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Target: 5.0, 6.0

This PR adds Markdown linting to this repo (with Markdownlint2, same as in devdoc).

The config is the same as in devdoc: https://github.com/ibexa/documentation-developer/blob/a8633fd032979025abd406be68eff424271e8338/.markdownlint-cli2.yaml

You can review by commit:

  • first commit adds the tool
  • second commit contains automatic fixes done by running yarn markdownlint --fix
  • third commit contains manual fixes (this one needs the most attention)
  • fourth commit adds CI integration

I didn't fix the Personalization files, as they're about to be removed and I don't want conflicts in this PR.

Previous PRs in devdoc:

@github-actions

Copy link
Copy Markdown

Preview of modified files

Preview of modified Markdown:

@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown

Summary

Status Count
🔍 Total 17411
🔗 Unique 1482
✅ Successful 586
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 16819
❓ Unknown 0
🚫 Errors 6
⛔ Unsupported 0

Errors per input

Errors in site/personalization/content_import/index.html

  • [ERROR] file:///home/runner/work/documentation-user/documentation-user/repositories/devdoc-5.0/site/personalization/enable_personalization/index.html#export-item-information (at 2599:69) | Cannot find fragment

Errors in site/personalization/enable_personalization/index.html

  • [ERROR] file:///home/runner/work/documentation-user/documentation-user/repositories/devdoc-5.0/site/personalization/enable_personalization/index.html#set-up-customer-credentials (at 2621:14) | Cannot find fragment
  • [ERROR] file:///home/runner/work/documentation-user/documentation-user/repositories/devdoc-5.0/site/personalization/enable_personalization/index.html#set-up-item-type-tracking (at 2622:14) | Cannot find fragment

Errors in site/personalization/integrate_scenario_results/index.html

  • [ERROR] file:///home/runner/work/documentation-user/documentation-user/repositories/devdoc-5.0/site/personalization/enable_personalization/index.html#parameters (at 2613:39) | Cannot find fragment

Errors in site/personalization/recommendation_models/index.html

  • [ERROR] file:///home/runner/work/documentation-user/documentation-user/repositories/devdoc-5.0/site/personalization/api_reference/recommendation_api/index.html#submodel-parameters (at 2925:36) | Cannot find fragment

Errors in site/personalization/triggers/index.html

  • [ERROR] file:///home/runner/work/documentation-user/documentation-user/repositories/devdoc-5.0/site/personalization/integrate_recommendation_service/index.html#send-messages-with-recommendations (at 2620:108) | Cannot find fragment

Full Github Actions output

@mnocon
mnocon marked this pull request as ready for review July 28, 2026 08:51
@mnocon
mnocon requested a review from a team July 28, 2026 08:54
@ibexa-workflow-automation-1
ibexa-workflow-automation-1 Bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team July 28, 2026 08:55
@mnocon
mnocon merged commit eb4198d into 5.0 Jul 29, 2026
10 of 12 checks passed
@mnocon
mnocon deleted the add-markdownlint branch July 29, 2026 10:22
mnocon added a commit that referenced this pull request Jul 29, 2026
* Added Markdown lint

* Run markdownlint --fix

* Manual fixes

* Added CI integration
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.

2 participants