-
Notifications
You must be signed in to change notification settings - Fork 60
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
Updates with more info #1118
Updates with more info #1118
Conversation
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.
I think that we added some valuable missing information but that we have also made it a lot lower level / complex to read.
Let's try to find a good middleground.
c087a82
to
5561d68
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.
Getting closer.
Some examples might go a lil too low-level + we are talking about implementation detail types, e.g, TransactionArguments
or BlockHeader
, might be okay for now.
Thank you! I think we are moving in the right direction - though, we are not quite there yet. One aspect is that language/phrasing can be improved throughout - but for now I won't focus on this. More importantly, I think we are missing some important pieces and I would also re-shuffle things a bit. Here is how I'm thinking of the overall structure:
|
Thanks @bobbinth. I changed the structure and mostly followed your approach. Let's not focus on the language now, but ensure we describe all protocol rules and provide sufficient examples to make it easy to follow. Can you take a look, Bobbin, to see if we describe "Consuming a P2ID note" in the right depth? @phklive can you take a stab at "Creating a P2ID note"? |
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.
Not a full review yet, but some initial comments.
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.
Looks good to me. I like the example of the P2ID note creation/consumption to make it more concrete!
Left some comments inline.
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.
I believe that we are starting to achieve a good state between high-level explanation and details.
One thing that we could do is to merge what is in the: **info**
and **good to know**
blocks directly into the text.
They seem out of place and as if it was information that we did not manage to fit.
Created an issue to incorporate the |
* Initiate structure for transaction * Updated transaction section * rename from plural to singular * Removed conclusions + Removed header for 'What is X' and replaced in by direct text * Updates with more info (#1118) * updates to the chapter * adding more clarity * First pass on the updated doc * changing the strucutre a bit * changing the strucutre a bit * Second wave of updates, improved wording, changed sentences, fixed formatting * Fix typo * after PHs review * Fix formatting, improve parts, fix typos, ready for review 👀 * after Bobbin's review * restructuring and adding more clarity * Added example for creating note + closed all comments 🎙️ * Fix typos‼️ * Specify the example for P2ID script and add RECIPIENT explanation ✅ * Remove image 📸 * Consolidate good to know --------- Co-authored-by: Paul-Henry Kajfasz <kajfaszph@gmail.com> --------- Co-authored-by: Dominik Schmid <35031754+Dominik1999@users.noreply.github.com>
I am adding some more info to the Transaction chapter. It explains a transaction as a process and provides a bit more context.
This is still a draft, but you can already comment. I will go over it a second time to also incorporate Bobbin's feedback.