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

enhancement: Test book in workflow #427

Open
tigerros opened this issue Dec 10, 2023 · 3 comments
Open

enhancement: Test book in workflow #427

tigerros opened this issue Dec 10, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@tigerros
Copy link
Contributor

The book has a lot of code that doesn't even compile. Testing the UI is overkill, but the book should not contain any code that doesn't compile.

@marc2332
Copy link
Owner

marc2332 commented Dec 10, 2023

Some examples are intentionally simplified, so if you just copy and paste them, they will obviously not compile. Is this what you meant?

@tigerros
Copy link
Contributor Author

tigerros commented Dec 10, 2023

They're part of what I meant, yes. I'm not sure if hiding lines with # is possible in mdbook, but that's what I'm proposing. I think adding # use freya::prelude::*; and some other imports would make most of the book compile. The problem is that right now, the book might be outdated, but you would need to manually check each code block to see if it is. It's what the Rust book uses to make sure their code isn't outdated.

@marc2332
Copy link
Owner

Ahh, sure, sgtm

@marc2332 marc2332 added the documentation Improvements or additions to documentation label Dec 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants