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

Include a deeper summary in project README #254

Open
dcramer opened this issue Dec 8, 2023 · 1 comment
Open

Include a deeper summary in project README #254

dcramer opened this issue Dec 8, 2023 · 1 comment
Assignees
@BYK
Labels
Type: Documentation Improvements or additions to documentation

Comments

@dcramer
Copy link
Member

dcramer commented Dec 8, 2023

Let's provide some degree of context in the README beyond just a link to docs. We shouldn't over rotate on code samples/etc as those change and we don't want to maintain (or have incorrect) duplicates of instructions.
@Shubhdeep12 Shubhdeep12 added the Type: Documentation Improvements or additions to documentation label Feb 10, 2024
@BYK BYK self-assigned this Nov 4, 2024
@BYK
Copy link
Member

BYK commented Nov 4, 2024

Related #543

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

@BYK BYK

Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dcramer @BYK @Shubhdeep12