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.

Sign up for GitHub

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

Jump to bottom

Summarize the documentation directly in README #91

Open
Tracked by #94
aadam-10 opened this issue Apr 4, 2023 · 0 comments
Open
Tracked by #94

Summarize the documentation directly in README #91

aadam-10 opened this issue Apr 4, 2023 · 0 comments
Assignees
@gabzim
Milestone
Documentation and...

Comments

@aadam-10
Copy link
Collaborator

aadam-10 commented Apr 4, 2023

Description and context

The readme should be updated to contain a condensed version of the full documentation (that's to be made available on Book). Please also include links in the README that point to the relevant sections of Book.

Definition of done

README is updated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gabzim gabzim

Labels
None yet
Projects
None yet
Milestone
Documentation and developer experience
Development

No branches or pull requests
2 participants
@gabzim @aadam-10