Describe repo contents in README #96
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
When the docs are in place, this section could also link out to the site where we provide information on the individual components. (This info lives in the wiki currently, but will be moved over in aranya-project/aranya-docs#37. Rn, the docs just have a diagram: https://aranya-project.github.io/aranya-docs/aranya-architecture/) Edit: oh, and the overview doc kinda talks about these components: https://aranya-project.github.io/aranya-docs/overview/#aranya-architecture |
shannynat
requested review from
elagergren-spideroak and
jdygert-spok
as code owners
shannynat
requested review from
gknopf-aranya,
ycarmy,
smckeon-so and
nikki-aranya
smckeon-so
reviewed
Feb 11, 2025
nikki-aranya
previously approved these changes
Feb 11, 2025
gknopf-aranya
previously approved these changes
Feb 11, 2025
ycarmy
reviewed
Feb 11, 2025
This change adds information about the repository's maintainers and rearranges the `Contributing` section to be above the `Maintainers` section. This mirrors the organization and information in the Aranya repo.
Adds a high-level description of the components that are included in this repository.
Consolidates the `What is it?` and `What's contained in this repo?` sections into one that describes what the core functionality is.
shannynat
force-pushed
the
readme-add-components
branch
from
7c27e53 to
7bf3f2d
Compare
shannynat
force-pushed
the
readme-add-components
branch
from
ee2ecf3 to
2cc53c9
Compare
gknopf-aranya
previously approved these changes
Feb 19, 2025
shannynat
dismissed stale reviews from gknopf-aranya and smckeon-so
via
ac8245e
jdygert-spok
approved these changes
Feb 19, 2025
nikki-aranya
approved these changes
Feb 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a high-level description of what is included in this repository.
Also, adds a
Maintainerssection and rearranges the contributing section to be next to this addition (matching the format of the aranya repo: aranya-project/aranya#39).