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

Create guide-level documentation / a Taffy "book" #554

Open
nicoburns opened this issue Oct 5, 2023 · 1 comment
Open

Create guide-level documentation / a Taffy "book" #554

nicoburns opened this issue Oct 5, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@nicoburns
Copy link
Collaborator

What problem does this solve or what need does it fill?

People often seem confused about how to approach / get started with using Taffy. And while Taffy has good rustdoc coverage, and a few basic examples, it doesn't really have good guide-level documentation.

What solution would you like?

Creation of guide-level documentation. Something like

What alternative(s) have you considered?

  • Try to add this information to the README / docs.rs docs.
  • Create a more involved / well-documented example (we could probably do this as well?)
@nicoburns nicoburns added the documentation Improvements or additions to documentation label Oct 5, 2023
@alice-i-cecile
Copy link
Collaborator

alice-i-cecile commented Oct 5, 2023

mdbook is a good simple tool for this. More than happy to help with the editing process here!

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