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

Include interactive Quick Start #30

Open
shannynat opened this issue Jan 16, 2025 · 1 comment
Open

Include interactive Quick Start #30

shannynat opened this issue Jan 16, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@shannynat
Copy link
Contributor

We have the walkthrough document that runs through a simple scenario using Aranya (creating and setting up a team, setting up syncing and afc messaging).

Alongside this documentation, we could include an interactive version provided by GitHub Codespaces. This would allow users to see the walkthrough running and mess around with the code to get a better understanding of how Aranya operates.

The quick start would need to be in its own repository and this documentation site could link to the codespace associated with the quick start repository.

@shannynat shannynat added the documentation Improvements or additions to documentation label Jan 16, 2025
@shannynat shannynat self-assigned this Jan 16, 2025
@gknopf-aranya
Copy link
Contributor

Other options are Jupyter notebooks and Google Colab.
Codespaces is more related to running code inside containers initialized by an IDE.

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

No branches or pull requests

2 participants