-
Notifications
You must be signed in to change notification settings - Fork 2
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
Conversation
@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 |
That was my feeling as well. |
There was a problem hiding this 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?
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. |
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. |
There was a problem hiding this 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!
b6d7aec
to
6e469c3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
Original PR:
https://git.spideroak-inc.com/spideroak-inc/aranya-core/pull/83