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

Pulldown-cmark mdBook #863

Open
Martin1887 opened this issue Mar 12, 2024 · 2 comments · May be fixed by #883
Open

Pulldown-cmark mdBook #863

Martin1887 opened this issue Mar 12, 2024 · 2 comments · May be fixed by #883
Labels
docs Documentation good first issue A good issue for beginners help wanted

Comments

@Martin1887
Copy link
Collaborator

The crate documentation of docs.rs is good for learning the API, but some things like examples and specs are difficult to find for end users, and a mdBook would improve a lot the user experience for these types of things.

@Martin1887 Martin1887 added the docs Documentation label Mar 12, 2024
@Martin1887 Martin1887 modified the milestone: v0.11 Mar 12, 2024
@Martin1887 Martin1887 added good first issue A good issue for beginners help wanted labels Mar 12, 2024
@Martin1887 Martin1887 pinned this issue Mar 12, 2024
@elijah-potter
Copy link

As someone currently using pulldown_cmark as a library, I personally haven't encountered any noticeable lack of documentation. What is an example of this?

@Martin1887
Copy link
Collaborator Author

I mean docs.rs is good for the API and a basic usage, but a book could provide a 'Getting started' chapter, and collecting examples currently only available in the code repository (https://github.com/pulldown-cmark/pulldown-cmark/tree/master/pulldown-cmark/examples).

Furthermore, the full specs could be easily checked (and with a great search engine!) instead of being only in the code repository and it could be also a good place for developers documentation, which is currently almost missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation good first issue A good issue for beginners help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants