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

Example Overview page #14

Open
RexShinka opened this issue Jan 5, 2019 · 0 comments
Open

Example Overview page #14

RexShinka opened this issue Jan 5, 2019 · 0 comments

Comments

@RexShinka
Copy link
Contributor

Add Example Overview page

Title: Example Overview page
Author: Rex Hygate @RexShinka 
Type: New page
Status: Draft
Created: 2019-01-05

Location

Within Introduction, just below Getting Started, as a level II heading. A link to this page will be included in every page that has an example.

Page Text

This is the text of the page to be added.

Examples

The guidelines have examples to give the reader the context into exactly what is being described. The examples are complete, self standing GitHub repositories. In each repository there are appropriate documents in the ./doc directory,the contract code is commented with requirements and heading comments. There are tests in the ./test directory that test the requirements and tool outputs of the various development tools to be used (still in development). The code complies and the test execute properly.

Crypto Zombie Example

The largest example in the guidelines uses the first Crypto Zombie. It covers the first five lessons on learning Solidity programming. Each lesson has its own documentation and test set. This allows us to show examples of change management as the code base changes from a simple app to a complete decentralized game. These examples are still under development.

CryptoZombies Lesson 1 Example
CryptoZombies Lesson 2 Example
CryptoZombies Lesson 3 Example
CryptoZombies Lesson 4 Example
CryptoZombies Lesson 5 Example

Wayback

This repository includes an example application created for the EyhBerlin hackathon in September 2018. The application is not complete but certain aspects of the documentation, especially the architecture files provide high quality examples of the documentation.

Wayback documentation


End of the text to be inserted

Impact

This will add one each to the Introduction section. A link to this page will be added to all pages that have examples.

Copyright

Copyright and related rights waived via CC0

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

No branches or pull requests

1 participant