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: update references from flow3-docs to aranya-docs #7

Merged
merged 15 commits into from
Jan 10, 2025

Conversation

gknopf-aranya
Copy link
Contributor

@gknopf-aranya gknopf-aranya commented Jan 3, 2025

@smckeon-so
Copy link
Contributor

@elagergren-spideroak @gknopf-aranya There are several references to a apq branch in the aranya-crypto crate. It's identical to our internal docs apq spec with the added bonus of updated links. Should we point to the internal spec?

@gknopf-aranya
Copy link
Contributor Author

@elagergren-spideroak @gknopf-aranya There are several references to a apq branch in the aranya-crypto crate. It's identical to our internal docs apq spec with the added bonus of updated links. Should we point to the internal spec?

I'd prefer to reference a spec that has been merged into main over one that is only on an unprotected branch. Esp. if they are the same

@smckeon-so smckeon-so requested a review from apetkov-so as a code owner January 7, 2025 22:53
@smckeon-so
Copy link
Contributor

I'd prefer to reference a spec that has been merged into main over one that is only on an unprotected branch. Esp. if they are the same

That was my feeling as well.

Copy link
Contributor

@smckeon-so smckeon-so left a comment

Choose a reason for hiding this comment

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

@gknopf-aranya There's a couple places where were referencing internal issues and one where we're still referencing flow3. Do we want to keep these?

crates/aranya-fast-channels/src/mutex.rs Outdated Show resolved Hide resolved
crates/aranya-policy-vm/tests/vm.rs Outdated Show resolved Hide resolved
crates/aranya-model/src/tests/mod.rs Outdated Show resolved Hide resolved
@gknopf-aranya
Copy link
Contributor Author

@gknopf-aranya There's a couple places where were referencing internal issues and one where we're still referencing flow3. Do we want to keep these?

If these are issues that apply to aranya and could be worked on in the future, then let's migrate those issues to the proper repository that's under active development and reference them here. If these are issues that only apply to an old tech stack or are not planned to be worked on in the future, then let's remove the references to them.

Curious to hear @ycarmy's thoughts on this too.

@smckeon-so
Copy link
Contributor

@gknopf-aranya There's a couple places where were referencing internal issues and one where we're still referencing flow3. Do we want to keep these?

If these are issues that apply to aranya and could be worked on in the future, then let's migrate those issues to the proper repository that's under active development and reference them here. If these are issues that only apply to an old tech stack or are not planned to be worked on in the future, then let's remove the references to them.

Curious to hear @ycarmy's thoughts on this too.

These are two closed issues and a reference to mutex patterns from go.

@gknopf-aranya
Copy link
Contributor Author

These are two closed issues and a reference to mutex patterns from go.

I don't see a reason to keep the references then. If an issue has been closed, it's no longer a todo. Although there could be instances where the todo referencing an issue needs to be updated to reference the new documentation generated by the issue.

apetkov-so
apetkov-so previously approved these changes Jan 8, 2025
Copy link
Contributor Author

@gknopf-aranya gknopf-aranya left a comment

Choose a reason for hiding this comment

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

@smckeon-so I'm unable to approve since I opened the PR. This lgtm!

ycarmy
ycarmy previously approved these changes Jan 8, 2025
smckeon-so
smckeon-so previously approved these changes Jan 8, 2025
@smckeon-so smckeon-so requested a review from ycarmy January 8, 2025 18:27
ycarmy
ycarmy previously approved these changes Jan 8, 2025
@apetkov-so apetkov-so self-requested a review January 8, 2025 19:46
apetkov-so
apetkov-so previously approved these changes Jan 8, 2025
@smckeon-so smckeon-so dismissed stale reviews from apetkov-so and themself via c2ea512 January 8, 2025 19:47
chip-so
chip-so previously approved these changes Jan 8, 2025
crates/aranya-model/src/tests/mod.rs Outdated Show resolved Hide resolved
Copy link
Contributor Author

@gknopf-aranya gknopf-aranya left a comment

Choose a reason for hiding this comment

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

lgtm!

@gknopf-aranya gknopf-aranya merged commit 8118a00 into main Jan 10, 2025
12 checks passed
@gknopf-aranya gknopf-aranya deleted the aranya-docs branch January 10, 2025 19:15
This was referenced Jan 11, 2025
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.

7 participants