Skip to content

[DOP-36248] Update contributing guide for mkdocs#481

Merged
dolfinus merged 1 commit intodevelopfrom
improvement/DOP-36248
May 4, 2026
Merged

[DOP-36248] Update contributing guide for mkdocs#481
dolfinus merged 1 commit intodevelopfrom
improvement/DOP-36248

Conversation

@dolfinus
Copy link
Copy Markdown
Member

@dolfinus dolfinus commented Apr 29, 2026

Change Summary

After replacing sphinx with mkdocs some things were not updated properly:

  • towncrier used .rst files instead of .md
  • release & CI workflow instruction relied on .rst files instead of .md
  • Makefile was not updated for sphinx->mkdocs replacement, as well as release instruction.

Fixed.

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@dolfinus dolfinus requested a review from wm-wm-wm April 29, 2026 09:37
@dolfinus dolfinus self-assigned this Apr 29, 2026
@dolfinus dolfinus added the ci:skip-changelog Add this label to skip changelog file check label Apr 29, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 29, 2026

Coverage

Coverage Report •
FileStmtsMissBranchBrPartCoverMissing
TOTAL103151508185237085% 
report-only-changed-files is enabled. No files were changed during this commit :)

@dolfinus dolfinus force-pushed the improvement/DOP-36248 branch from 4a18fe6 to 70b47d3 Compare April 30, 2026 08:50
Comment thread mddocs/docs/changelog/index.md
Comment thread mddocs/docs/changelog/NEXT_RELEASE.md Outdated
Comment thread mddocs/docs/contributing.md Outdated
Comment thread mddocs/docs/nav.md
Comment thread CONTRIBUTING.rst Outdated
@dolfinus dolfinus force-pushed the improvement/DOP-36248 branch 2 times, most recently from 1fa80a7 to fc2a8cd Compare May 3, 2026 09:17
@dolfinus dolfinus force-pushed the improvement/DOP-36248 branch from fc2a8cd to 346f42a Compare May 3, 2026 09:17
@dolfinus dolfinus requested a review from wm-wm-wm May 3, 2026 09:18
@dolfinus dolfinus merged commit d708d99 into develop May 4, 2026
132 of 133 checks passed
@dolfinus dolfinus deleted the improvement/DOP-36248 branch May 4, 2026 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:skip-changelog Add this label to skip changelog file check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants