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

Move internal product doc into open aranya-docs #28

Open
smckeon-so opened this issue Jan 16, 2025 · 2 comments
Open

Move internal product doc into open aranya-docs #28

smckeon-so opened this issue Jan 16, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@smckeon-so
Copy link
Collaborator

We have internal product docs that could be useful to open source users. They should be placed in the documentation site. https://github.com/aranya-project/aranya-docs They are currently located in the internal aranya-docs wiki. https://git.spideroak-inc.com/spideroak-inc/aranya-docs/wiki

We'll need to find an elegant solution to host both specs and doc in the same place. Namely how to differentiate them from each other.

@smckeon-so smckeon-so added the documentation Improvements or additions to documentation label Jan 16, 2025
@smckeon-so smckeon-so added this to the Open-Source Aranya Docs milestone Jan 16, 2025
@smckeon-so smckeon-so self-assigned this Jan 16, 2025
@gknopf-aranya
Copy link
Contributor

Can they be placed in different subfolders? Does the GitHub pages template allow for different sections in the navigation menu?

@smckeon-so
Copy link
Collaborator Author

Can they be placed in different subfolders? Does the GitHub pages template allow for different sections in the navigation menu?

Out of the box no, but we can update the template.

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

2 participants