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

README: Make Getting Started higher-level and integration focused #38

Open
shannynat opened this issue Jan 6, 2025 · 1 comment · May be fixed by #39
Open

README: Make Getting Started higher-level and integration focused #38

shannynat opened this issue Jan 6, 2025 · 1 comment · May be fixed by #39
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@shannynat
Copy link
Contributor

This may include changing it from Getting Started to Integration, but we should include the following information:

  • step-by-step details for installing and building the code. Includes:
    • system requirements
    • dependencies with version numbers
    • exact terminal commands for every step (including cloning the git repo)
  • practical example steps.
    • Essentially, the outline from the walkthrough doc.
    • References the included examples (C, rust app)
  • real-life integration steps
  • small example of 'participating with Aranya'
    • References the walkthrough/tutorial doc
    • Example API calls: creating a team, adding sync peers, or getting key bundle to be added to team
@shannynat shannynat added the documentation Improvements or additions to documentation label Jan 6, 2025
@shannynat shannynat self-assigned this Jan 6, 2025
@shannynat shannynat linked a pull request Jan 6, 2025 that will close this issue
@shannynat shannynat linked a pull request Jan 6, 2025 that will close this issue
@gknopf-aranya gknopf-aranya added this to the Open-Source Aranya Docs milestone Jan 6, 2025
@shannynat
Copy link
Contributor Author

Example for these changes: https://github.com/aregtech/areg-sdk#readme

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