This repository has been archived by the owner on Jan 24, 2022. It is now read-only.
Cleanup the READMEs #276
Merged
Cleanup the READMEs #276
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #232
facuspagnuolo
approved these changes
Oct 17, 2018
There was a problem hiding this comment.
Amazing job @ElOpio! Loved the progress you did, left some minor comments.
| @@ -1,5 +1,5 @@ | |||
| * ZeppelinOS (zOS for short): a platform to develop, deploy and operate smart | |||
| contract applications on Ethereum and every other EVM and eWASM-powered | |||
| contract projects on Ethereum and every other EVM and eWASM-powered | |||
| Then, clone the repository: | ||
|
|
||
| ```sh | ||
| git clone https://github.com/zeppelinos/zos-docs.git |
There was a problem hiding this comment.
shouldn't we ask the user to clone the main zos repo and navigate to packages/docs instead?
git clone https://github.com/zeppelinos/zos.git
cd ./packages/docs
There was a problem hiding this comment.
@ElOpio IMO this step needs to be fixed since we are not using that repo anymore
There was a problem hiding this comment.
Sorry I missed one, but thanks a lot for taking care of it @facuspagnuolo! <3
packages/docs/README.md
Outdated
| `npm install -g docusaurus-init` | ||
| ```sh | ||
| npm install --global docusaurus-init | ||
| ``` | ||
|
|
||
| Navigate to the `docs/website` directory and run: |
There was a problem hiding this comment.
I think this is docs/docs/website
There was a problem hiding this comment.
🤔 it depends what is the reference directory.
from the root of the repo, this is packageds/docs/docs/website. But from the directory where this README is located, it's docs/website.
This is very confusing :D any preference?
There was a problem hiding this comment.
Note that I suggested navigating to the package above, so if we apply that change this should be just /docs/website I think
| [`zos` command-line interface](https://github.com/zeppelinos/zos/tree/master/packages/cli#zeppelinos-command-line-interface), | ||
| which is the recommended way to use ZeppelinOS; but this library can also be | ||
| used directly to operate ZeppelinOS projects when a programmatic interface is | ||
| preferred or more flexibility and lower-level access is required. |
|
The only one missing would be to work on the vouching readme as well, I don't if you preferred to leave that one for later |
|
@facuspagnuolo I reported #290 for the vouching README. Today I spent time learning about vouching, so now I can put some useful info in there. Will get back to do it early next week. |
facuspagnuolo
pushed a commit
that referenced
this pull request
Oct 23, 2018
* [CI skip] First draft of a new section describing the unstructured storage proxy pattern. * [CI skip] Finished first draft of Proxy section. * [CI skip] Merged some items in advanced.md to proxies.md * [CI skip] Assimilated some of elopio's reviews * [CI skip] Minor spelling fixes * [CI skip] Added a few diagrams to the proxies section. * Modified advanced section about json files to account for light mode. * Removed (or names!) * [CI skip] updated advanced section, jsons sub-section about the --full option. * [CI skip] Typo fix explicitely > explicitly * Update dependencies version on push (#279) * Reupload contract if related lib has changed (#280) * Add vouching kovan deploy * Use version of dependency for identifying proxies in network json file (#281) Changes both create and update commands to retrieve the package version of either the project package or the dependency package when annotating the proxy version in the network json file. * Link command now successfully runs npm install again (#278) * Check if project is published before freeze (#285) * Check if project is published before freeze * Check if package exists instead of if app exists * docs: remove basil and crafty demos (#277) The demos are outdated. For 2.0, they should probably be replaced with simpler examples. Fixes: #96 [CI skip] * Stdlib/lib/dependency rename to package (#240) * Rename stdlib/dependency to package Fix unit tests Modify option on integration test command call Rename dependencies to packages in vouching Change and revert some names Change 'package' to 'dependencies' when necessary * Implement suggestions from spalladino * Fix storage layout parsing when there are complex types (#286) Given a contract with a mapping or array (not struct), the check for whether it contained structs or enums failed if there was no variable with the same type as the value type of the mapping or array. For instance, a contract with a variable of type `array(string)` and another `string` would work, but a contract with just `array(string)` would fail. * Change status fix/fetch error message (#289) * Preserve error stack trace when using ScriptError (#287) * Update and unify package json files structures (#282) * Check if package is frozen before uploading solidity libs (#284) Previously the check was done only when uploading contracts, and caused the solidity lib upload to fail with an EVM revert. * Cleanup the READMEs (#276) * Clean the main README Fixes #232 * Added links to the blog and twitter * Added links to the blog and twitter * Update the docs README with suggestions by @facuspagnuolo * Fix docs readme clone instructions * Update to v2.0.0-rc.0 * Update CLI package lock * Use latest versions of TPL-eth and OZ-eth (#295) * Update to v2.0.0 * Fix vouching deployment script * Update CLI package lock * Update TPL-eth and OZ-eth to latest released versions * Add zos files to vouching package files list * Applied @facuspagnuolo's suggestion about publish [CI skip] * docs: restructure the docs webiste Fixes: zeppelinos/zos-docs#94 [CI skip] * Remove the duplicated proxies * Fix the new in zOS 2 page. [CI skip] * [CI skip] * correction for consistency * fix small mistakes * fix small mistakes
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #232
[CI skip]