Skip to content

Commit bcbb7d2

Browse files
committed
Further changes to structure
1 parent 58572fd commit bcbb7d2

22 files changed

+142
-12
lines changed

source/mainnet/conf.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@
389389
"./net/smart-contracts/general/images/smart-contract-lifecycle.png": "docs/smart-contracts/images/smart-contract-lifecycle.png",
390390
"./net/references/manage-accounts": "docs/protocol/manage-accounts.html",
391391
"./net/images/concepts/account-creation.png": "docs/protocol/images/account-creation.png",
392-
"./net/smart-contracts/guides/setup-tools": "docs/smart-contracts/guides/setup-tools.html",
392+
"./net/smart-contracts/guides/setup-tools": "docs/smart-contracts/guides/build-contract.html",
393393
"./net/smart-contracts/guides/setup-contract": "docs/smart-contracts/guides/setup-contract.html",
394394
"./net/smart-contracts/guides/compile-module": "docs/smart-contracts/guides/compile-module.html",
395395
"./net/smart-contracts/guides/build-schema": "docs/smart-contracts/guides/build-schema.html",
@@ -401,4 +401,18 @@
401401
"./net/smart-contracts/guides/unit-test-contract": "docs/smart-contracts/guides/unit-test-contract.html",
402402
"./net/smart-contracts/guides/development": "docs/smart-contracts/guides/development.html",
403403
"./net/smart-contracts/guides/costs": "docs/smart-contracts/guides/costs.html",
404+
"./net/guides/company-identities": "docs/protocol/company-identities.html",
405+
".net/images/company-id-request.png": "docs/protocol/images/company-id-request.png",
406+
".net/images/company-id-create.png": "docs/protocol/images/company-id-create.png",
407+
".net/images/company-id-acct-keys.png": "docs/protocol/images/company-id-acct-keys.png",
408+
".net/images/company-id-recover.png": "docs/protocol/images/company-id-recover.png",
409+
".net/concepts/concepts-transactions": "docs/protocol/concepts-transactions.html",
410+
".net/concepts/concepts-baker": "docs/protocol/concepts-baker.html",
411+
".net/concepts/concepts-delegation": "docs/protocol/concepts-delegation.html",
412+
".net/images/concepts/baker-process1.png": "docs/protocol/images/baker-process1.png",
413+
".net/images/concepts/baker-process2.png": "docs/protocol/images/baker-process2.png",
414+
".net/smart-contracts/guides/initialize-contract": "docs/smart-contracts/guides/initialize-contract.html",
415+
".net/smart-contracts/guides/interact-instance": "docs/smart-contracts/guides/interact-instance.html",
416+
".net/smart-contracts/guides/inspect-instance": "docs/smart-contracts/guides/inspect-instance.html",
417+
".net/smart-contracts/guides/invoke-instance": "docs/smart-contracts/guides/invoke-instance.html"
404418
}

source/mainnet/docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ This is the documentation
1010
What is the Concordium Protocol? <protocol/introduction>
1111
Identities <protocol/id-accounts>
1212
Accounts <protocol/manage-accounts>
13+
Transactions <protocol/transactions>
14+
Network <protocol/network>
1315

1416
.. toctree::
1517
:caption: Smart Contracts
1618

1719
What is a smart contract? <smart-contracts/introduction>
18-
QuickStart <smart-contracts/guides/quick-start>
20+
QuickStart to smart contract deployment <smart-contracts/guides/quick-start>
1921
Build a smart contract <smart-contracts/guides/build-contract>
2022
Deploy a smart contract <smart-contracts/guides/deploy-module>
2123

source/mainnet/net/guides/company-identities.rst renamed to source/mainnet/docs/protocol/company-identities.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Request identity
2727

2828
#. Write down or save your seedphrase by clicking the copy button to copy your seedphrase to the clipboard and remember to go to the clipboard and save the file. Keep your seedphrase secure as you will need it to create accounts or recover the identity. Click **Proceed**.
2929

30-
.. image:: ../images/company-id-request.png
30+
.. image:: ../protocol/images/company-id-request.png
3131
:alt: company id tool screen showing identities related to seedphrase and option to select
3232

3333
#. Enter your seedphrase to verify that you have recorded it correctly. Click **Proceed**.
@@ -51,7 +51,7 @@ After obtaining the ``id-object.json`` identity object from the identity provide
5151

5252
#. Enter your seedphrase in the Enter seedphrase field. In the Identity object file field click to navigate to the location of the stored ``id-object.json`` file. Click **Get Accounts**.
5353

54-
.. image:: ../images/company-id-create-acct.png
54+
.. image:: ../protocol/images/company-id-create-acct.png
5555
:alt: company id tool screen showing seedphrase field and file selection box
5656

5757
#. On the next screen, click **Create Account** to create an account with this company identity. When prompted, save the ``account-keys.json`` in a secure location as you will need them to interact with the account on-chain. You can click **Create account** again to create another account.
@@ -60,7 +60,7 @@ After obtaining the ``id-object.json`` identity object from the identity provide
6060

6161
If you are trying to recover the ``account-keys.json`` file(s), you can also use **Create Account**. After entering your seedphrase and selecting your ``id-object.json`` file you will see a list of account associated with this seedphrase and ID object. Click **Save** to save the ``account-keys.json`` for that account.
6262

63-
.. image:: ../images/company-id-acct-keys.png
63+
.. image:: ../protocol/images/company-id-acct-keys.png
6464
:alt: company id tool screen showing seedphrase field and file selection box
6565

6666
.. dropdown:: Format of the key files
@@ -139,7 +139,7 @@ If the identity object used to create credentials is lost, it can be recovered f
139139

140140
#. You see a list of accounts associated with the seedphrase. It is possible to save the account keys that can be ussed to interact with the account on the chain. Indices that are to the left of the account address are pointing to the identity index, being the first value and the account index being the second value (0,0). In the Identities to recover drop-down, select the identity you want to recover. There will always be one additional index on the list for selection to be sure that request can be generated for more than one identity. This is mainly useful in cases where first identity object was lost or unused to create accounts. Click **Generate recovery request**. The command outputs the ``recovery-request.json`` file. The request should be sent to the identity provider through a trusted channel. When the request has been verified successfully, you will receive an email with an identity object. Store this file securely as you need it to create accounts on the chain.
141141

142-
.. image:: ../images/company-id-recover.png
142+
.. image:: ../protocol/images/account-creation.png
143143
:alt: company id tool screen showing identities related to seedphrase and option to select
144144

145145
- For Mainnet requests: Send the file to [email protected] together with any other required identity data as described in the `entity verification instructions <https://notaben.notion.site/Entity-verification-next-1b4fbcd8e32042e1ac3b0018a3cc27bc>`_.

source/mainnet/net/concepts/concepts-baker.rst renamed to source/mainnet/docs/protocol/concepts-baker.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ Overview of the validation process
3333

3434
#. If the combined effective stake of the validators who sign the block is *greater than or equal to* two-thirds of the total stake, the block gets a :term:`Quorum Certificate` (QC) that certifies that this is a valid block. Without the QC the new round cannot progress.
3535

36-
.. image:: ../images/concepts/baker-process1.png
36+
.. image:: ../protocol/images/baker-process1.png
3737
:alt: diagram of validator process
3838

3939
6. The next validator (Alice) now uses the QC to produce the next block. The new block can only extend the previous block when a QC is presented to Alice.
4040

41-
.. image:: ../images/concepts/baker-process2.png
41+
.. image:: ../protocol/images/baker-process2.png
4242
:alt: diagram of validator process
4343

4444
If there are no issues, the protocol repeats this process from step 3.
File renamed without changes.

source/mainnet/net/concepts/concepts-transactions.rst renamed to source/mainnet/docs/protocol/concepts-transactions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _transactions-overview:
33

44
=====================
5-
Transactions overview
5+
Transaction anatomy
66
=====================
77

88
A transaction on the Concordium blockchain is an operation which applies some change to the chain. All transactions are recorded on the chain and once recorded, they are immutable. A transaction always has one sender :term:`account` and is signed using the :term:`keys<private keys>` of this account.

source/mainnet/docs/protocol/id-accounts.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,6 @@ For information about accounts, see :ref:`Accounts<managing_accounts>`.
8080
:hidden:
8181
:maxdepth: 1
8282

83-
../guides/company-identities
83+
company-identities
84+
8485

source/mainnet/net/images/concepts/baker-process1.png renamed to source/mainnet/docs/protocol/images/baker-process1.png

File renamed without changes.

source/mainnet/net/images/concepts/baker-process2.png renamed to source/mainnet/docs/protocol/images/baker-process2.png

File renamed without changes.

source/mainnet/net/images/company-id-acct-keys.png renamed to source/mainnet/docs/protocol/images/company-id-acct-keys.png

File renamed without changes.

0 commit comments

Comments
 (0)