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

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

Closed
1 of 4 tasks
Tracked by #223
Savio-Sou opened this issue Apr 29, 2024 · 1 comment
Closed
1 of 4 tasks
Tracked by #223

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

Savio-Sou opened this issue Apr 29, 2024 · 1 comment
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 •
edited
Loading

Problem

Our docs README hasn't been updated to cover the number of documentation scripts and tooling introduced.

This creates knowledge gaps for contributing documentations and documented code.

Happy Case

Document how to document in docs/README.md:

Tasks
Preview Give feedback

Feel free to convert the above into standalone Issues.

Alternatives

Document in CONTRIBUTING.md and link to it in docs/README.md.

Project Impact

Nice-to-have

Impact Context

Eases documentation contributions.

Would you like to submit a PR for this Issue?

No
@Savio-Sou Savio-Sou added enhancement New feature or request documentation Improvements or additions to documentation labels Apr 29, 2024
@Savio-Sou Savio-Sou added this to Noir Apr 29, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Apr 29, 2024
@Savio-Sou Savio-Sou added the good first issue Good for newcomers label Apr 29, 2024
@critesjosh critesjosh mentioned this issue Jun 21, 2024
Open
@Savio-Sou Savio-Sou mentioned this issue Aug 11, 2024
Merged
5 tasks
@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
@TomAFrench TomAFrench closed this as not planned Won't fix, can't repro, duplicate, stale Feb 4, 2025
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Feb 4, 2025
@Savio-Sou
Copy link
Collaborator Author

@TomAFrench why are we closing this?

@Savio-Sou Savio-Sou moved this from ✅ Done to 📋 Backlog in Noir Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Noir
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@TomAFrench @Savio-Sou