If something doesn't make sense, make a comment using GitBook, or ask in the Discord.
If you are confident that something is wrong, just fix it. There's no need to ask.
If you think something doesn't have enough detail, expand on it, or leave a comment suggesting that.
If a page is getting too long, break it down into new pages. If you're unsure, then leave a comment or talk in the discord
If you want to write about something new and learn as you type, this is fine! But please leave a warning at the top that this is new to you and needs another pair of eyes.
If there's big subject you're working on, claim the page and save it, show us that that's what you're doing so we don't overlap too much
Introduce new objects slowly, if many things need to be assumed, then try to plan for them to appear within the Book Plan somewhere.
It is better to cover less, and explain something well, than it is to quickly cover a lot. We're not racing
When explaining anything, imagine you are introducing it for a first time. Summaries exist elsewhere online, the goal of CryptoBook is education
Contribute as much or as little as you want, but try to only work on topics that
You are interested in
You have some experience of thinking about
External resources should be included at the end of the page. Ideally the book should be self-contained (within reason) but other resources are great as they offer other ways to learn
Try and use the hints / tips blocks to break up dense text, for example:
A page should have a clear educational goal: this should be explained in the introduction. References to prerequisites should be kept within the book and if the book doesnt have this yet, it should be placed into Book Plan.
The topic should be presented initially with theory, showing the mathematics and structures we will need. A discussion should be pointed towards how this appears within Cryptography
Within a discussion of a topic, a small snippet of code to give an example is encouraged
If you write code better than you write maths, then just include what you can and the page will form around that
An example page is given in Sample Page
There's no "right or wrong" but it's good to be consistent, I think?
All maths must be presented using using either both block and inline
We seem to be using
mathbb for our fields / rings. So let's stick with that? Maybe someone has a good resource for notation we can work from?
Make sure all code blocks have the right language selected for syntax highlighting
Preference is to SageMath, then to Python, then others.
Code should be cope-pastable. So if you include print statement, include the result of the output as a comment
# Examplea = 3b = 6print(a+b)# 9
Algorithms should be presented as??