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: Added a 'how it all works' page #316

Merged
merged 2 commits into from Aug 9, 2023
Merged

docs: Added a 'how it all works' page #316

merged 2 commits into from Aug 9, 2023

Conversation

gkc
Copy link
Contributor

@gkc gkc commented Aug 9, 2023

- What I did
docs: Added a 'how it all works' page. It's the first iteration, we will improve on this over time.
Note: one of the links ("how notifications work") will not work until atsign-foundation/at_protocol#98 is merged to trunk

- How to verify it
Please review for typos etc

@gkc gkc requested a review from cpswan August 9, 2023 14:47
Copy link
Member

@cpswan cpswan left a comment

Choose a reason for hiding this comment

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

This material perhaps belongs elsewhere in the repo as it seems to cover the approach generically rather than specifically for the Dart implementation.

@gkc gkc merged commit d240bc0 into trunk Aug 9, 2023
13 checks passed
@gkc gkc deleted the docs/under-the-hood branch August 9, 2023 15:15
@gkc
Copy link
Contributor Author

gkc commented Aug 9, 2023

Good point. I'll move it to the root in the next PR

@cpswan
Copy link
Member

cpswan commented Aug 9, 2023

This repo probably needs a docs directory

And a lot of the existing docs (that aren't Dart implementation specific) can go in there.

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.

None yet

2 participants