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

ci: test the code examples within docs page #3874

Open
masci opened this issue Jan 17, 2023 · 0 comments
Open

ci: test the code examples within docs page #3874

masci opened this issue Jan 17, 2023 · 0 comments
Labels
topic:CI type:documentation Improvements on the docs

Comments

@masci
Copy link
Contributor

masci commented Jan 17, 2023

Is your feature request related to a problem? Please describe.
Code examples from https://docs.haystack.deepset.ai/ can be easily copied and pasted into a notebook for testing, which is great. Sometimes though, the code doesn't work and it might be hard to find out why if you're a fresh Haystack user.

Describe the solution you'd like
We should routinely test all the code snippets from the docs pages; docs are edited on Readme but we don't need immediate feedback, it could be enough running the tests once per day in a nightly fashion.

Describe alternatives you've considered
Alternatives look overly complex and I wouldn't put them here.

@masci masci added type:documentation Improvements on the docs topic:CI labels Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:CI type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

1 participant