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

Feature: Source api documentation #28

Merged
merged 5 commits into from
Sep 2, 2024

Conversation

mikolasstuchlik
Copy link
Contributor

This pull request adds the documentation to source files and initial article documentation for DocC. It includes diagram provided by @samoilyk.

What remains to be done:

  • Documentation of suggested data flows
  • Data flows for persisted data (architecture and documentation)
  • Templates for Navigation coordinator
  • We should harmonize naming

@mikolasstuchlik mikolasstuchlik requested review from jmarek41, samoilyk, ssestak and a team August 23, 2024 18:43
Copy link
Contributor

@ssestak ssestak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only noticed 3 typos. Other than that, nice documentation 👍

Co-authored-by: ssestak <126681667+ssestak@users.noreply.github.com>
ssestak
ssestak previously approved these changes Aug 27, 2024
@@ -1,19 +1,40 @@
import Foundation

/// `DataCache` is intended to store application state which may be used by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather use data state instead of application state. Application state is often more than just a data state. Could be navigation state as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed the work application instead.

@samoilyk
Copy link
Contributor

@mikolasstuchlik good job 👏

@mikolasstuchlik mikolasstuchlik merged commit 5f7a43e into main Sep 2, 2024
1 check passed
@mikolasstuchlik mikolasstuchlik deleted the feature/version-1-documentation branch September 2, 2024 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants