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

Link out to integration details in the docs in relevant READMEs #53

Open
shannynat opened this issue Feb 6, 2025 · 2 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@shannynat
Copy link
Contributor

Based on this comment: aranya-project/aranya#39 (comment), we should have in-depth information on the integration steps in the docs (#38) rather than in the READMEs. The README can then link out to the relevant sections of the docs, rather than maintaining this information in multiple places and overwhelming the README with these details.

@shannynat shannynat added the documentation Improvements or additions to documentation label Feb 6, 2025
@shannynat
Copy link
Contributor Author

Initially, we should use the content from the Aranya README's Getting Started section (added here: aranya-project/aranya#39). Having this information on the docs site will allow us to more clearly differentiate the ways it can be installed/built/integrated. Also, will give us room to add information to each of those sections.

This should be added under the Getting Started section of the docs site, as a top-level doc (initially, could be multiple docs depending on how the information is best divided up).

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

1 participant