Skip to content

updates to whitepaper, readme.md and directory structure#25

Merged
iamdefinitelyahuman merged 52 commits intozerolawtech:masterfrom
lex-node:legal-updates
Nov 24, 2019
Merged

updates to whitepaper, readme.md and directory structure#25
iamdefinitelyahuman merged 52 commits intozerolawtech:masterfrom
lex-node:legal-updates

Conversation

@lex-node
Copy link
Collaborator

@lex-node lex-node commented Nov 4, 2019

No description provided.

@iamdefinitelyahuman
Copy link
Collaborator

Good stuff @lex-node! A couple things that jump out at me immediately:

  1. Can you add .idea/ to the gitignore and remove that folder from your PR?
  2. We should avoid whitespace in filenames - I think dashes make the most sense to maintain consistency with other files in the docs/ folder.

I'll delve into the whitepaper shortly.

Copy link
Collaborator

@iamdefinitelyahuman iamdefinitelyahuman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a thing of beauty :) Thank you for putting so much work into this! Some general comments:

  • The mix of markdown and HTML kinda hurts my brain, but we discussed moving away from markdown so I didn't flag anything related to that
  • We need to address #21 as a part of this PR, so we can rename everything once and for all and then finalize all the links
  • I'm not a huge fan of the full function selectors including inputs, I think if you aren't later discussing the usage of specific variables we could reduce them to just ContractName.functionName

Overall really good content here! Very excited to roll this out.

@lex-node lex-node closed this Nov 13, 2019
@lex-node lex-node reopened this Nov 13, 2019
@lex-node
Copy link
Collaborator Author

  1. Can you add .idea/ to the gitignore and remove that folder from your PR?
  2. We should avoid whitespace in filenames - I think dashes make the most sense to maintain consistency with other files in the docs/ folder.

these are now done

  • The mix of markdown and HTML kinda hurts my brain, but we discussed moving away from markdown so I didn't flag anything related to that
  • We need to address rename smart contracts for whitepaper consistency/maximum generality  #21 as a part of this PR, so we can rename everything once and for all and then finalize all the links
  • I'm not a huge fan of the full function selectors including inputs, I think if you aren't later discussing the usage of specific variables we could reduce them to just ContractName.functionName

these are now done

@iamdefinitelyahuman
Copy link
Collaborator

Per the comments, I will write a section on the rationale behind our module system as opposed to using a proxy pattern.

@iamdefinitelyahuman iamdefinitelyahuman merged commit 0a3d7bf into zerolawtech:master Nov 24, 2019
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