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

Migrate to mdBook documentation #549

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Migrate to mdBook documentation #549

merged 1 commit into from
Oct 10, 2023

Conversation

elshize
Copy link
Member

@elshize elshize commented Oct 8, 2023

Fixes #505


The intention is to host docs at pisa-engine.github.io/book


Most of "CLI Reference" description is missing, should be filled up with more details in the future.

@elshize elshize self-assigned this Oct 8, 2023
@elshize elshize requested review from JMMackenzie and amallia October 8, 2023 21:50
@elshize
Copy link
Member Author

elshize commented Oct 9, 2023

Note that docs/book are generated files, no need to review.

Copy link
Member

@JMMackenzie JMMackenzie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neato! Fixing documentation is a big "want" for me but I am too time poor 😿

@elshize
Copy link
Member Author

elshize commented Oct 10, 2023

Neato! Fixing documentation is a big "want" for me but I am too time poor

Yeah, this still will need more work but we need to be better about it.

@elshize elshize merged commit f4bff69 into master Oct 10, 2023
7 checks passed
@elshize elshize deleted the mdbook branch October 10, 2023 12:02
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.

Migrate from Sphinx to mdBook
2 participants