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

docs: improve documentation quality #172

Closed
4 tasks
jaybxyz opened this issue Oct 15, 2021 · 1 comment · Fixed by #212
Closed
4 tasks

docs: improve documentation quality #172

jaybxyz opened this issue Oct 15, 2021 · 1 comment · Fixed by #212
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jaybxyz
Copy link
Contributor

jaybxyz commented Oct 15, 2021

Summary

Documentation has areas for improvement. These are some of the areas that I am concerned with:

  • Are there any typos or grammatical mistakes?
  • How smooth an explanation is written?
  • Is there consistency of documentation style?
  • Is there any area where it should provide more information?
  • ...

Proposal

Team Korea would be really grateful if @barriebyron could spare some time to review our documentation and help us to improve documentation quality.

Tasks

Completed Oct 21:

Delivered: Technical content style guidance for Farming

CODEOWNERS


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@jaybxyz
Copy link
Contributor Author

jaybxyz commented Oct 22, 2021

From the Technical content style guidance, it is suggested to use main or develop branch instead of master branch. Also, @barriebyron suggests to add make proto-all guidance in CONTRIBUTING.md doc.

@jaybxyz jaybxyz mentioned this issue Oct 26, 2021
9 tasks
barriebyron pushed a commit that referenced this issue Oct 27, 2021
docs: edit farming spec to improve documentation quality (part of #172)
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants