Skip to content

#252 Make under-construction warning GitHub-friendly - #254

Closed
parfenovma wants to merge 1 commit into
ucl-bug:developfrom
parfenovma:252-github-friendly-warning
Closed

parfenovma wants to merge 1 commit into
ucl-bug:developfrom
parfenovma:252-github-friendly-warning

Conversation

@parfenovma

Copy link
Copy Markdown
Contributor

Summary

  • Replace the MkDocs-specific admonition syntax with a standard Markdown blockquote.
  • Keep the under-construction warning readable in both the published documentation and the GitHub README view.

Testing

  • pre-commit run --files docs/README.md
  • mkdocs build

Related Issues

Closes #252

Contributor Agreement

  • By submitting this pull request, I confirm I have read the Legal and Licensing section in CONTRIBUTING.md, and I agree that my contributions may be redistributed under the k-Wave-II open-source license.

Peer Review

Review summary (complete before merge):

  • New (unit) test/s implemented - not applicable
  • All (unit) test/s pass - not applicable
  • New code is documented - documentation-only change
  • Documentation builds and looks right
  • Examples/Tutorials added - not applicable
  • Linting tests pass
  • Code review:
    • Implementation is sensible
    • Code meets coding standard
    • Issue description is complete

@parfenovma parfenovma closed this Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Admonition block looks nice on docs page but not on GitHub

1 participant