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

docs: improve crate documentation #153

Merged
merged 20 commits into from
Sep 17, 2024
Merged

docs: improve crate documentation #153

merged 20 commits into from
Sep 17, 2024

Conversation

saidsay-so
Copy link
Owner

@saidsay-so saidsay-so commented Sep 12, 2024

Closes #40

Copy link
Collaborator

@asomers asomers left a comment

Choose a reason for hiding this comment

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

This looks like a good change. Is there a rendered version of the book online somewhere where I may see it?

book/src/compatibility.md Outdated Show resolved Hide resolved
rust/src/config.rs Outdated Show resolved Hide resolved
rust/src/macros.rs Outdated Show resolved Hide resolved
rust/src/config.rs Outdated Show resolved Hide resolved
@saidsay-so
Copy link
Owner Author

saidsay-so commented Sep 16, 2024

This looks like a good change. Is there a rendered version of the book online somewhere where I may see it?

Unfortunately, you have to build it to preview it. You have to run ./build.sh in the book directory and then use a server to serve it (python -m http.server build should suffice).

@saidsay-so saidsay-so merged commit 5780368 into master Sep 17, 2024
3 checks passed
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.

Provide package documentation
2 participants