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

Standardize codebase docs #53

Closed
kenpaicat opened this issue Jul 11, 2023 · 1 comment
Closed

Standardize codebase docs #53

kenpaicat opened this issue Jul 11, 2023 · 1 comment
Assignees
@Skrivni @tipkovnica3
Labels
A-Docs area of documentation D-2 easy T-Enh-Read readability enhancement T-Refactor refactor T-Tracker tracking something (issue/PR). will be added to MoSCoW board as Must-Have.

Comments

@kenpaicat
Copy link
Contributor

kenpaicat commented Jul 11, 2023 •
edited
Loading

  • All API docs must look about the same and must be True.
  • All CONTRIBUTING.md sections must be short and on point
  • Optional: Some things can be marked #[doc(hidden)] (ie. having a struct and fn after macro is applied on eg. get_me() function in laguna-backend-api).
  • Slovenščina? (Za vse).
  • User-facing docs in laguna-docs.
  • Lektura obstoječih docsov.
@kenpaicat kenpaicat added D-13 hard T-Enh-Read readability enhancement T-Refactor refactor S-UNSTAGED A-Docs area of documentation D-2 easy and removed D-13 hard labels Jul 11, 2023
@kenpaicat kenpaicat changed the title Simplify & standardize codebase docs Standardize codebase docs Jul 11, 2023
@kenpaicat kenpaicat added the T-Tracker tracking something (issue/PR). will be added to MoSCoW board as Must-Have. label Jul 11, 2023
@kenpaicat kenpaicat pinned this issue Jul 11, 2023
@kenpaicat kenpaicat mentioned this issue Jul 11, 2023
Closed
@kenpaicat kenpaicat unpinned this issue Jul 17, 2023
@kenpaicat
Copy link
Contributor Author

Fixed recently by moving stuff into docs repo.

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

@Skrivni Skrivni

@tipkovnica3 tipkovnica3

Labels
A-Docs area of documentation D-2 easy T-Enh-Read readability enhancement T-Refactor refactor T-Tracker tracking something (issue/PR). will be added to MoSCoW board as Must-Have.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kenpaicat @Skrivni @tipkovnica3