search

zerolawtech / ZAP-Tech

ZeroLaw Augmentation Protocol
GNU General Public License v3.0
27 stars 13 forks source link

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

Closed lex-node closed 4 years ago

iamdefinitelyahuman commented 4 years ago

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.

lex-node commented 4 years ago
  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 #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 commented 4 years ago

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