From 78b62f6ad31ee0ea19bcd4e8c52d25e7ec5a8000 Mon Sep 17 00:00:00 2001 From: Mark Hendrickson Date: Tue, 5 Jan 2021 16:56:48 +0100 Subject: [PATCH] fix: build app page paths - Update transaction-signing and BNS path references - Update collections overview --- next.config.js | 72 +++++++++---------- src/common/navigation.yaml | 60 ++++++---------- src/pages/build-apps/collections/overview.md | 6 +- src/pages/build-apps/collections/types.md | 2 + .../build-apps/guides/transaction-signing.md | 2 +- .../build-apps/tutorials/public-registry.md | 4 +- 6 files changed, 66 insertions(+), 80 deletions(-) diff --git a/next.config.js b/next.config.js index 6abb39b5..23e3539d 100755 --- a/next.config.js +++ b/next.config.js @@ -98,7 +98,7 @@ async function redirects() { }, { source: '/develop/connect/use-with-clarity.html', - destination: '/write-smart-contracts/signing-transactions', + destination: '/build-apps/transaction-signing', permanent: true, }, { @@ -118,32 +118,32 @@ async function redirects() { }, { source: '/core/naming/introduction.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/architecture.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/namespaces.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/comparison.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/tutorial_subdomains.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/search.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { @@ -158,37 +158,37 @@ async function redirects() { }, { source: '/core/naming/pickname.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/creationhowto.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/resolving.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/register.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/manage.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/subdomains.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/core/naming/forks.html', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { @@ -416,8 +416,8 @@ async function redirects() { { source: '/data-storage', destination: '/data-storage/overview', permanent: true }, { source: '/data-indexing', destination: '/data-storage/indexing-overview', permanent: true }, { source: '/stacks-wallet', destination: '/stacks-wallet/overview', permanent: true }, - { source: '/naming-services', destination: '/technology/naming-system/', permanent: true }, - { source: '/naming-system', destination: '/technology/naming-system/', permanent: true }, + { source: '/naming-services', destination: '/build-apps/references/bns', permanent: true }, + { source: '/naming-system', destination: '/build-apps/references/bns', permanent: true }, { source: '/storage-hubs', destination: '/storage-hubs/overview', permanent: true }, { source: '/references', destination: '/references/stacks-cli', permanent: true }, { source: '/ecosystem', destination: '/ecosystem/overview', permanent: true }, @@ -499,88 +499,88 @@ async function redirects() { }, { source: '/naming-services/build-profile-search-index', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/build-profile-search-index', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/build-profile-search-index', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/build-profile-search-index', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/architecture', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/choose-name', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/comparison', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/create-namespace', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/did', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/forks', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/manage-names', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/namespaces', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/overview', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/register-name', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/resolve-name', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/subdomains', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { source: '/naming-services/subdomains-tutorial', - destination: '/technology/naming-system/', + destination: '/build-apps/references/bns', permanent: true, }, { @@ -630,7 +630,7 @@ async function redirects() { }, { source: '/smart-contracts/signing-transactions', - destination: '/write-smart-contracts/signing-transactions', + destination: '/build-apps/transaction-signing', permanent: true, }, { @@ -740,12 +740,12 @@ async function redirects() { }, { source: '/smart-contracts/public-registry-tutorial', - destination: '/write-smart-contracts/public-registry-tutorial', + destination: '/build-apps/tutorial/public-registry', permanent: true, }, { source: '/smart-contracts/public-registry-tutorial', - destination: '/writing-smart-contracts/public-registry-tutorial', + destination: '/build-apps/tutorial/public-registry', permanent: true, }, { diff --git a/src/common/navigation.yaml b/src/common/navigation.yaml index 24a502fa..d9c3c975 100644 --- a/src/common/navigation.yaml +++ b/src/common/navigation.yaml @@ -44,54 +44,37 @@ sections: - path: /hello-world-tutorial - path: /counter-tutorial - path: /testing-contracts - - path: /signing-transactions - - path: /public-registry-tutorial - - path: /build-apps # is an overview page - - path: /start-mining # is an overview page - - - title: Technology - pages: - - path: /authentication - pages: - - path: /overview - sections: - - title: Tutorials - usePageTitles: true - pages: - - path: /building-todo-app - - path: /building-with-angular - - path: /data-storage + - path: /build-apps pages: - path: /overview - - path: /storage-guide - - path: /authentication - - path: /storage-write-read - - path: /collections - - path: /collection-type sections: - - title: Data Indexing + - title: Guides usePageTitles: true pages: - - path: /indexing-overview - - path: /indexing-models - - path: /indexing-collaborate - - path: /indexing-server-extras + - path: /guides/authentication + - path: /guides/transaction-signing + - path: /guides/data-storage + - title: Tutorials + usePageTitles: true pages: - - path: /integrate-indexing - - path: /naming-system # is an overview page - - path: /storage-hubs # this seems out of date, kill? - pages: - - path: /overview - - path: /gaia-admin - sections: - - title: Tutorials + - path: /tutorials/todos + - path: /tutorials/angular + - path: /tutorials/indexing + - path: /tutorials/public-registry + + - title: References usePageTitles: true pages: - - path: /amazon-ec2-deploy - - path: /digital-ocean-deploy + - path: /references/stacks-connect + - path: /references/bns + - path: /references/gaia + - external: + href: 'https://blockstack.github.io/stacks.js/' + title: Stacks.js + - path: /start-mining + - path: /references - usePageTitles: true pages: - path: /stacks-cli - path: /stacking-contract @@ -113,6 +96,7 @@ sections: - path: /language-types - path: /language-keywords - path: /language-functions + - title: Ecosystem pages: - path: /overview #pbc et al diff --git a/src/pages/build-apps/collections/overview.md b/src/pages/build-apps/collections/overview.md index 3f2d2eb5..b7ef8b43 100644 --- a/src/pages/build-apps/collections/overview.md +++ b/src/pages/build-apps/collections/overview.md @@ -1,8 +1,10 @@ --- title: Overview -description: Store data in standardized formats +description: Store data in standardized formats with Collections --- +~> Collections are an experimental feature not yet recommended for production. Please report issues and contribute through [the blockstack-collections repository](https://github.com/blockstack/blockstack-collections/). + ## Introduction Collections is the feature designed to make data portable among Stacks applications. Sharing is accomplished by @@ -12,8 +14,6 @@ a user's decentralized ID. When users move among apps, the same data is availabl On this page, you learn what collections are and how to use them. You'll learn about the `Contact` collection in particular. The following topics are covered: --> This is a preview release of the `Contact` collections. This release allows developers to try out the new collections functionality and we are interested in collecting feedback. Please feel free to report issues or request enhancements with collections or `Contacts` themselves on the [blockstack-collections repository](https://github.com/blockstack/blockstack-collections/issues/new). - ~> If you encounter problems with `blockstack.js` you can [file issues or request enhancements on its repo](https://github.com/blockstack/blockstack.js/issues/new). ## Understand how collections work diff --git a/src/pages/build-apps/collections/types.md b/src/pages/build-apps/collections/types.md index f3616235..bd7fbed3 100644 --- a/src/pages/build-apps/collections/types.md +++ b/src/pages/build-apps/collections/types.md @@ -3,6 +3,8 @@ title: Types description: Create new collection types --- +~> Collections are an experimental feature not yet recommended for production. Please report issues and contribute through [the blockstack-collections repository](https://github.com/blockstack/blockstack-collections/). + ## Introduction Collections support data portability between applications. Stacks supplies a `Contact` collection for use by Stacks applications. Developers can create additional collection types, use them in their own applications, and publish them so other developers can make use of them too. diff --git a/src/pages/build-apps/guides/transaction-signing.md b/src/pages/build-apps/guides/transaction-signing.md index ef5f2383..e942d547 100644 --- a/src/pages/build-apps/guides/transaction-signing.md +++ b/src/pages/build-apps/guides/transaction-signing.md @@ -13,7 +13,7 @@ images: This guide explains how to prompt users to sign transactions and broadcast them to the Stacks blockchain by implementing the `connect` package of [Stacks.js](https://blockstack.github.io/stacks.js/). -Transaction signing provides a way for users execute [smart contracts written in Clarity](/write-smart-contracts/overview) that are relevant to your app then handle the result immediately. +Transaction signing provides a way for users execute [Clarity smart contracts](/write-smart-contracts/overview) that are relevant to your app then handle the result immediately. Users can sign transactions that exchange fungible or non-fungible tokens with upfront guarantees while retaining complete control over their digital assets. diff --git a/src/pages/build-apps/tutorials/public-registry.md b/src/pages/build-apps/tutorials/public-registry.md index ac96daa9..be93f581 100644 --- a/src/pages/build-apps/tutorials/public-registry.md +++ b/src/pages/build-apps/tutorials/public-registry.md @@ -38,7 +38,7 @@ Furthermore, the to-do app will interact with a smart contract deployed as `ST12 You should have followed the instructions of the to-do app tutorial. You should have the code ready on your local machine. It is also helpful to have a basic understanding of Clarity as explained in the counter tutorial. If you are using mocknet or a new, empty testnet you can create transactions following the tutorial about signing transactions. [@page-reference | grid] -| /authentication/building-todo-app, /write-smart-contracts/counter-tutorial, /write-smart-contracts/signing-transactions +| /authentication/building-todo-app, /write-smart-contracts/counter-tutorial, /build-app/guides/signing-transactions ### Check your to-do app @@ -120,7 +120,7 @@ export const PublicUrlRegistrar = ({ userSession }) => { }; ``` -It is a simple button that calls `doContractCall` method of the Connect library when clicked. The method makes an api call to the Stacks authenticator. The authenticator creates a contract call transaction that is signed by the user and then it is broadcasted to the Stacks 2.0 blockchain as explained in the [transaction signing tutorial](/write-smart-contracts/signing-transactions). +It is a simple button that calls `doContractCall` method of the Connect library when clicked. The method makes an api call to the Stacks authenticator. The authenticator creates a contract call transaction that is signed by the user and then it is broadcasted to the Stacks 2.0 blockchain as explained in the [transaction signing tutorial](/build-app/guides/signing-transactions). Note how the arguments are created using `bufferCVFromString`. There are similar methods for all other Clarity types, like `uintCV` or `trueCV`. See the [documentation](https://github.com/blockstack/stacks.js/tree/master/packages/transactions#constructing-clarity-values) of the stacks-transactions library for more details.