Skip to content

Conversation

@Tom-Willemsen
Copy link
Member

Description of work

Fix a number of issues causing docs rendering to be bad.

I still think the docs format as a whole can be improved, but these are low-hanging fruit to make our docs actually useful.

To test

Which ticket does this PR fix?

Acceptance criteria

List the acceptance criteria for the PR


Code Review

  • Is the code of an acceptable quality?
  • Are there unit tests in place? Are the unit tests small and test the a class in isolation?
  • Have the changes been documented in the release notes. If so, do they describe the changes appropriately?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed.
  • How do the changes handle unexpected situations, e.g. bad input?
  • Has developer documentation been updated if required?

@Tom-Willemsen Tom-Willemsen requested a review from rerpha October 14, 2025 14:00
@github-project-automation github-project-automation bot moved this to Flash Review in Tasks Oct 14, 2025
@rerpha rerpha merged commit ffc5cbc into main Oct 14, 2025
15 checks passed
@rerpha rerpha deleted the docs_rendering branch October 14, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants