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.

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

Update the extending/frameworks.md page with mkdocs-material #568

Open
PGijsbers opened this issue Jul 20, 2023 · 1 comment
Open

Update the extending/frameworks.md page with mkdocs-material #568

PGijsbers opened this issue Jul 20, 2023 · 1 comment
Labels
Documentation Something needs to be added or fixed in the documentation

Comments

@PGijsbers
Copy link
Collaborator

We moved to mkdocs-material pages for documentation in PR #565, but I did not get around the extending/frameworks.md page yet. It would be great if the page could be updated to make it easier to read using mkdocs-material features such as admonitions and tabs. It also needs some careful reading to see if things are up to date, and perhaps there is room for improvement in general.

@PGijsbers PGijsbers added the Documentation Something needs to be added or fixed in the documentation label Jul 20, 2023
@PGijsbers
Copy link
Collaborator Author

Also add test coverage for the example, like adding a script which follows the step in an automated way to ensure that the docs are up-to-date. To avoid a situation like #593.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Something needs to be added or fixed in the documentation
Projects
None yet
Development

No branches or pull requests

1 participant