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

Split cryptnono docs into a how-to and a topic #31

Closed

Conversation

sgibson91
Copy link

@sgibson91 sgibson91 commented Jan 31, 2024

This PR splits up the cryptnono docs into a how-to and a topic from a single how-to. I am recommending this approach because

  1. It can be overwhelming to have this much information on a single page - smaller chunks are generally more digestible
  2. There is information here (such as future work, R2R considerations) that are important to have documented, but are superfluous to the steps an engineer should take to enable this feature. Hence the recommendation to move them into a topic section that is linked to from the how-to.

📚 Documentation preview 📚: https://2i2c-pilot-hubs--31.org.readthedocs.build/en/31/

@yuvipanda
Copy link
Owner

ok this is super amazing @sgibson91! I'll work on resolving the conflicts and bringing this through.

I really appreciate this work, as documentation structure is something I often struggle with.

@yuvipanda
Copy link
Owner

Moved into 2i2c-org#3681

@yuvipanda yuvipanda closed this Feb 1, 2024
@sgibson91 sgibson91 deleted the cryptnono-docs-refactor branch April 13, 2024 09:36
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.

2 participants