Skip to content
This repository has been archived by the owner on Jan 24, 2022. It is now read-only.

Restructure documentation #1286

Closed
frangio opened this issue Nov 19, 2019 · 0 comments · Fixed by #1380
Closed

Restructure documentation #1286

frangio opened this issue Nov 19, 2019 · 0 comments · Fixed by #1380
Labels
kind:documentation Write or review documentation content

Comments

@frangio
Copy link
Contributor

frangio commented Nov 19, 2019

As part of a bigger review of the documentation (OpenZeppelin/docs.openzeppelin.com#47), we're restructuring the content. The idea is to organize it in a conceptual hierarchy rather than divide it in "Basics" and "Advanced".

The SDK docs will be split into CLI and Upgrades. The structure should be as follows. Most of these articles already exist, except the ones in italics.

CLI

  • Overview (incl: Your first project)
  • Compiling
  • Create & Upgrade (incl: create2)
  • Interacting with contracts
  • Dependencies (i.e. “linking oz contracts”)
  • Verify
  • Admins (set-admin)
  • Ethereum Packages (incl: “contracts architecture”?)
  • Using with Truffle
  • API Reference
    • Commands
    • Config Files

Upgrades

  • Overview
  • Programmatic library
  • Writing upgradeable contracts
  • Proxies (aka “Upgrades pattern”)
  • Testing upgradeable projects ? (may want to remove this one)

The following should be moved to the "entry guides" section (which doesn't exist yet):

  • Building a GSN powered dapp
  • Deploying to a public network

The following should be moved to the forum:

  • Upgrades governance
  • Onboarding ERC20 tokens
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind:documentation Write or review documentation content
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants