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

chore(book): adding help and contributing pages #311

Merged
merged 5 commits into from
Jun 23, 2023

Conversation

jeertmans
Copy link
Collaborator

@jeertmans jeertmans commented May 26, 2023

This PR adds meta pages to help people know how they can get help and how they can contribute to this project.

The internals page is still WIP.

Some more context:

I decided to remove the "redundant" information in the README for two main reasons:

  1. in my opinion, a README should just be a short introduction to the crate, especially when there exists an online documentation and a book;
  2. having the same code and explanations in multiple places, but from distinct sources, makes it harder to keep up-to-date (like when you when from Iterator<Item = Token> to Iterator<Item = Result<Token, Error>>) and can easily lead to errors.

@jeertmans jeertmans added the book Related to the book label Jun 23, 2023
@jeertmans jeertmans merged commit 8bfee51 into maciejhirsz:book Jun 23, 2023
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
book Related to the book
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant