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

Epic: Document how to document in noir/docs/README.md #4940

Open
4 tasks
Tracked by #223
Savio-Sou opened this issue Apr 29, 2024 · 0 comments
Open
4 tasks
Tracked by #223

Epic: Document how to document in noir/docs/README.md #4940

Savio-Sou opened this issue Apr 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Apr 29, 2024

Problem

Our docs README hasn't been updated for a while.

During the period, we've introduced a number of scripts and tooling that improve our docs. Documenting how to utilize the features in the README would be great.

Happy Case

Tasks

Feel free to convert the above into Issues.

Project Impact

Nice-to-have

Impact Context

Great for easing docs contributions.

Workaround

None

Workaround Description

No response

Additional Context

No response

Would you like to submit a PR for this Issue?

None

Support Needs

No response

@Savio-Sou Savio-Sou added enhancement New feature or request documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 29, 2024
@Savio-Sou Savio-Sou changed the title Update noir/docs/README.md - document how to document Epic: Document how to document in noir/docs/README.md Aug 11, 2024
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 enhancement New feature or request good first issue Good for newcomers
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant