diff --git a/components/home/modules/ROOT/pages/index.adoc b/components/home/modules/ROOT/pages/index.adoc index 8e91705d..f2635186 100644 --- a/components/home/modules/ROOT/pages/index.adoc +++ b/components/home/modules/ROOT/pages/index.adoc @@ -1,14 +1,14 @@ = Documentation -Explore our guides and examples to learn how. test dsfasfasfzz +Explore our guides and examples to learn how. TODO == The modular governance stack -Explanation here +TDOO Explanation here === Aragon OSx -Docs here +TODO Docs here === Plugin marketplace @@ -17,10 +17,15 @@ Governance logic is encapsulated in reusable contracts called _plugins_. Plugins are granted specific permissions depending what you want them to do. In practice, they often act as governing bodies or decision-making processes. For example, a token voting plugin or multisig plugin define all of their unique governance logic within the plugin itself. This “separation of concerns” keeps the protocol focused and ultimately more flexible. The core plugins currently supported by Aragon are: -* *Token Voting*: Proposals are created for token holders and delegates to vote on proposals, with execution decided using a simple majority rule. -* *Multisig*: Proposals are created for designated addresses to approve, with execution decided by whether a minimum number of approvers is met. -* *Admin*: Proposals are created by designated addresses and immediately executed. -* *Staged Proposal Processor*: Proposals are created and progress through any number of stages, with other plugins either voting to approve or veto the proposal. The SPP plugin is essentially a cross-plugin state manager that enables governance processes with multiple stages and multiple governing bodies. + + * *Token Voting*: Proposals are created for token holders and delegates to vote on proposals, with execution decided using a simple majority rule. + + * *Multisig*: Proposals are created for designated addresses to approve, with execution decided by whether a minimum number of approvers is met. + + * *Admin*: Proposals are created by designated addresses and immediately executed. + + * *Staged Proposal Processor*: Proposals are created and progress through any number of stages, with other plugins either voting to approve or veto the proposal. The SPP plugin is essentially a cross-plugin state manager that enables governance processes with multiple stages and multiple governing bodies. + [.card-section] diff --git a/package.json b/package.json index 1eee9259..5cd4b5ee 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "serve:all-optimized": "yarn && yarn optimize-svg && yarn build && yarn serve", "optimize-svg": "svgo -rf ./static/img -o ./static/optimized-svg", "build:theme": "yarn --cwd ui build", - "serve": "live-server build/site", + "serve": "yarn build && live-server build/site", "watch:local": "fgbg 'nodemon -e yml,adoc,css,scss,js -w components -w ui --ignore ui/theme/dist -x sh scripts/watch-local-build.sh' 'live-server build/site'", "typecheck": "tsc", "lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix" diff --git a/playbook-local-only.yml b/playbook-local-only.yml index 88497825..62cfd2b7 100644 --- a/playbook-local-only.yml +++ b/playbook-local-only.yml @@ -1,19 +1,51 @@ site: title: Aragon Docs - url: https://docs.aragon.org + url: http://localhost/ start_page: ROOT::index.adoc keys: google_analytics: 'UA-85043059-1' + gtm: 'GTM-W9X5Q6F' content: sources: - url: . - branches: HEAD + branches: feature/new-way start_path: components/home + - url: https://github.com/aragon/multisig-plugin + branches: feature/docs + start_path: packages/contracts/docs + - url: https://github.com/aragon/token-voting-plugin + branches: feature/docs + start_path: packages/contracts/docs + - url: https://github.com/aragon/admin-plugin + branches: feat/docs + start_path: packages/contracts/docs + - url: /Users/claubar/Projects/Aragon/osx/ + branches: feat/docs-add-missing-pages + start_path: packages/contracts/docs + - url: https://github.com/aragon/osx-commons + branches: feature/docs + start_path: contracts/docs + - url: https://github.com/aragon/staged-proposal-processor-plugin + branches: feature/docs + start_path: docs + - url: https://github.com/aragon/gov-ui-kit + branches: feat/documentation-antora + start_path: docs + - url: https://github.com/aragon/gov-app-template + branches: feat/documentation-antora + start_path: docs + ui: bundle: url: ./ui/theme asciidoc: attributes: idprefix: '' +antora: + extensions: + - require: './lunr-tokenizer' + - require: '@antora/lunr-extension' + index_latest_only: true urls: - redirect_facility: netlify + html_extension_style: drop + redirect_facility: netlify \ No newline at end of file diff --git a/ui/preview/model.yml b/ui/preview/model.yml index 71f8e9f7..4c59852f 100644 --- a/ui/preview/model.yml +++ b/ui/preview/model.yml @@ -1,7 +1,7 @@ antoraVersion: '1.0.0' env: [] site: - title: OpenZeppelin Docs + title: Aragon Docs ui: url: /_ components: diff --git a/ui/src/css/article.scss b/ui/src/css/article.scss index 81430e33..b8afd199 100644 --- a/ui/src/css/article.scss +++ b/ui/src/css/article.scss @@ -1,5 +1,8 @@ .article { padding-bottom: var(--guk-space-5); /* matches nav padding */ + max-width: 900px; + margin:0 auto; + padding: 40px; .listingblock { position: relative; @@ -37,6 +40,10 @@ img { max-width: 100%; + height: auto; + display: block; + margin-left: auto; + margin-right: auto; } aside { @@ -262,13 +269,12 @@ a { text-decoration: none; - /* text-transform: uppercase; */ font-size: var(--guk-font-size-base); color: var(--guk-color-neutral-500); } a:hover { - color: var(--guk-color-neutral-800); + color: var(--guk-color-primary-400); } &.btn-next { diff --git a/ui/src/css/globals/_typography.scss b/ui/src/css/globals/_typography.scss index e2d57b24..f06fa673 100644 --- a/ui/src/css/globals/_typography.scss +++ b/ui/src/css/globals/_typography.scss @@ -37,7 +37,6 @@ h6 { /* font-weight: var(--guk-font-weight-semibold); /* 600 */ line-height: var(--guk-line-height-tight); /* 1.25 */ margin-bottom: var(--guk-space-4); /* Consistent spacing */ - margin-top: var(--guk-space-8); } /* @@ -130,9 +129,6 @@ a { color: var(--guk-color-primary-400); } - .admonitionblock & { - color: inherit; - } } /* Preformatted Text */ diff --git a/ui/src/css/header.scss b/ui/src/css/header.scss index 9d4901c8..e273403a 100644 --- a/ui/src/css/header.scss +++ b/ui/src/css/header.scss @@ -2,7 +2,6 @@ .header { border-bottom: solid 1px var(--guk-color-neutral-200); /* Replaces #e2e2e7 */ - padding:1em 0em 1em 0em; } .navbar { @@ -76,9 +75,8 @@ } .navbar-search-input { - margin-right: 8px; font-size: var(--guk-font-size-base); /* 1rem */ - background-color: var(--guk-color-neutral-0); /* Replaces var(--aluminum-1) */ + background-color: var(--guk-color-neutral-50); /* Replaces var(--aluminum-1) */ color: var(--guk-color-neutral-500); border-radius: var(--guk-border-rounded); border: 1px solid var(--guk-color-neutral-200); /* Replaces var(--aluminum-3) */ diff --git a/ui/src/css/layout.scss b/ui/src/css/layout.scss index e5a30334..a6be13e3 100644 --- a/ui/src/css/layout.scss +++ b/ui/src/css/layout.scss @@ -9,9 +9,20 @@ overflow-y: auto; position: sticky; top: 0; - width: 20%; - max-width: 300px; flex: 0 0 auto; + width: 300px; // default narrow width + + @media (min-width: 1000px) { + width: 300px; // medium screens + } + + @media (min-width: 1400px) { + width: 350px; // middle screens + } + + @media (min-width: 1800px) { + width: 400px; // larger screens + } } .nav-heading { @@ -108,6 +119,7 @@ button.collapse-toggle { .navbar, .article-wrapper { margin: 0 var(--side-margin); + max-width : 1280px; } .navbar { @@ -138,11 +150,11 @@ button.collapse-toggle { .navbar-search { position: relative; display: flex; - /* flex-grow: 1; */ + flex-grow: 1; } .navbar-search-input { - /* flex-grow: 1; */ + flex-grow: 1; width: 20em; padding: .5rem !important; } @@ -180,12 +192,27 @@ button.collapse-toggle { margin-left: var(--lg); flex-grow: 0; flex-shrink: 0; - width: 20%; - max-width: 300px; max-height: 80vh; position: sticky; top: 10vh; overflow-y: auto; + padding: 1rem; + padding-left: 0; + width: 300px; + + @media (min-width: 1000px) { + width: 250px; // medium screens + } + + @media (min-width: 1500px) { + width: 300px; // medium screens + } + + + @media (min-width: 1800px) { + width: 350px; // larger screens + } + @media (max-width: math.div($mobile-breakpoint * 2, 3)) { display: none; diff --git a/ui/theme/images/Aragon_OSx_Thumbnail.png b/ui/theme/images/Aragon_OSx_Thumbnail.png new file mode 100644 index 00000000..16d71789 Binary files /dev/null and b/ui/theme/images/Aragon_OSx_Thumbnail.png differ diff --git a/ui/theme/images/apple-touch-icon.png b/ui/theme/images/apple-touch-icon.png new file mode 100644 index 00000000..b8da9ac0 Binary files /dev/null and b/ui/theme/images/apple-touch-icon.png differ diff --git a/ui/theme/images/favicon-16x16.png b/ui/theme/images/favicon-16x16.png index 0124c0b9..e82970af 100644 Binary files a/ui/theme/images/favicon-16x16.png and b/ui/theme/images/favicon-16x16.png differ diff --git a/ui/theme/images/favicon-192x192.png b/ui/theme/images/favicon-192x192.png deleted file mode 100644 index d5a57590..00000000 Binary files a/ui/theme/images/favicon-192x192.png and /dev/null differ diff --git a/ui/theme/images/favicon-32x32.png b/ui/theme/images/favicon-32x32.png index 0555df7a..7ac47fc5 100644 Binary files a/ui/theme/images/favicon-32x32.png and b/ui/theme/images/favicon-32x32.png differ diff --git a/ui/theme/images/favicon-96x96.png b/ui/theme/images/favicon-96x96.png deleted file mode 100644 index 5ff809b9..00000000 Binary files a/ui/theme/images/favicon-96x96.png and /dev/null differ diff --git a/ui/theme/images/favicon.ico b/ui/theme/images/favicon.ico new file mode 100644 index 00000000..0d28740c Binary files /dev/null and b/ui/theme/images/favicon.ico differ diff --git a/ui/theme/images/logo-light.png b/ui/theme/images/logo-light.png new file mode 100644 index 00000000..cd5aea29 Binary files /dev/null and b/ui/theme/images/logo-light.png differ diff --git a/ui/theme/images/social.png b/ui/theme/images/social.png deleted file mode 100644 index 0a086819..00000000 Binary files a/ui/theme/images/social.png and /dev/null differ diff --git a/ui/theme/partials/header.hbs b/ui/theme/partials/header.hbs index 4ae8cdb1..1b71fa58 100644 --- a/ui/theme/partials/header.hbs +++ b/ui/theme/partials/header.hbs @@ -6,25 +6,11 @@ - +