Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Doc 2.0 #1066

Draft
wants to merge 37 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
b08101a
Add initial settings for doc 2.0
limemloh Oct 3, 2024
e8c925d
Add missing files
limemloh Oct 3, 2024
58572fd
New structure Protocol and Smart Contracts
TinaKT Oct 4, 2024
bcbb7d2
Further changes to structure
TinaKT Oct 7, 2024
19ab4b7
More changes to to structure
TinaKT Oct 7, 2024
9f95c4a
Clenaup
TinaKT Oct 7, 2024
7aea190
Overline too short fixed
TinaKT Oct 7, 2024
da8e539
fixing include
TinaKT Oct 7, 2024
7b57de4
Added newline at end of file
TinaKT Oct 7, 2024
12b66af
Added image
TinaKT Oct 7, 2024
c05be3d
cleanup in old docs
TinaKT Oct 7, 2024
2d6662e
cleanup
TinaKT Oct 7, 2024
8e9a3ab
Cleanup
TinaKT Oct 7, 2024
0d4c79d
cleanup
TinaKT Oct 7, 2024
49e33ce
cleanup
TinaKT Oct 7, 2024
0185a70
cleanup
TinaKT Oct 7, 2024
b08e8ad
using old delegation-faq
TinaKT Oct 7, 2024
b3c255e
reference to build-contract
TinaKT Oct 7, 2024
9c845d7
rename setup-tools to build-contract
TinaKT Oct 7, 2024
7a31b57
file moved
TinaKT Oct 7, 2024
19b3f0e
Structure-phase-2
TinaKT Oct 13, 2024
facabc0
Addings-structure-phase-2
TinaKT Oct 15, 2024
06d6374
Transaction-Fees-page-created
TinaKT Oct 15, 2024
98b2065
Fixed various bugs from lint and build
TinaKT Oct 15, 2024
5d1b448
Fixed includes
TinaKT Oct 15, 2024
317d038
Fixed include
TinaKT Oct 15, 2024
fec2a23
Fixed includes
TinaKT Oct 15, 2024
12c2b69
Fixed references
TinaKT Oct 15, 2024
57c8999
Fixed references
TinaKT Oct 15, 2024
aadc288
Fixed references
TinaKT Oct 15, 2024
76598c2
Moved files from downloads and installation to new structure
TinaKT Oct 28, 2024
61919a4
Moved glossary and Delegation and Validation FAQ into new structure
TinaKT Oct 28, 2024
ef32529
Cleanup
TinaKT Oct 28, 2024
8b0bc0d
Merge branch 'main' into doc2
TinaKT Oct 28, 2024
3791adf
Added newline
TinaKT Oct 28, 2024
3ac7b71
Removed run-node-aws
TinaKT Oct 28, 2024
131f666
new reference added
TinaKT Oct 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 126 additions & 0 deletions source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
/* Custom styling for the Pydata Sphinx Theme */
/* See https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/styling.html. */

html {
/*****************************************************************************
* Font features used in this theme
*/

/* base font size - applied at body/html level */
--pst-font-size-base: 1rem;

/* heading font sizes based on a medium contrast type scale */
/* - see: https://github.com/Quansight-Labs/czi-scientific-python-mgmt/issues/97#issuecomment-2310531483 */
--pst-font-size-h1: 2.625rem;
--pst-font-size-h2: 2.125rem;
--pst-font-size-h3: 1.75rem;
--pst-font-size-h4: 1.5rem;
--pst-font-size-h5: 1.25rem;
--pst-font-size-h6: 1rem;

/* smaller than heading font sizes */
--pst-font-size-milli: 0.9rem;

/* Sidebar styles */
--pst-sidebar-font-size: 0.9rem;
--pst-sidebar-font-size-mobile: 1.1rem;
--pst-sidebar-header-font-size: 1.2rem;
--pst-sidebar-header-font-weight: 600;

/* Admonition styles */
--pst-admonition-font-weight-heading: 600;

/* Font weights */
--pst-font-weight-caption: 300;
--pst-font-weight-heading: 600;

/* Font family */
/* These are adapted from https://systemfontstack.com/ */
--pst-font-family-base-system: 'IBM Plex Sans', 'Helvetica Neue', Arial, sans-serif;
--pst-font-family-monospace-system: 'IBM Plex Mono', 'Menlo', 'DejaVu Sans Mono',
'Bitstream Vera Sans Mono', Courier, monospace;
--pst-font-family-base: var(--pst-font-family-base-system);
--pst-font-family-heading: var(--pst-font-family-base-system);
--pst-font-family-monospace: var(--pst-font-family-monospace-system);


/*****************************************************************************
* Colors
**/

/* specified with RGB or hexcodes */
--pst-color-primary: #48A2AE;
--pst-color-primary-text: #333333;
--pst-color-secondary: #052535;
--pst-color-link: #48A2AE;
--pst-color-link-hover: #48A2AE;
--pst-color-inline-code: 178, 34, 34;
--pst-color-sidebar-link-hover: #48A2AE;
--pst-color-toc-link-hover: #48A2AE;
--pst-color-toc-link-active: #48A2AE;
--pst-color-headerlink: #48A2AE;
--pst-color-headerlink-hover: #48A2AE;
--bg-color: #ffffff;
--heading-color: #333333;
--font-color: #333333;

/*****************************************************************************
* Admonitions
**/

--pst-icon-admonition-default: var(--pst-icon-bell);
--pst-icon-admonition-note: var(--pst-icon-info-circle);
--pst-icon-admonition-attention: var(--pst-icon-exclamation-circle);
--pst-icon-admonition-caution: var(--pst-icon-exclamation-triangle);
--pst-icon-admonition-warning: var(--pst-icon-exclamation-triangle);
--pst-icon-admonition-danger: var(--pst-icon-exclamation-triangle);
--pst-icon-admonition-error: var(--pst-icon-times-circle);
--pst-icon-admonition-hint: var(--pst-icon-lightbulb);
--pst-icon-admonition-tip: var(--pst-icon-lightbulb);
--pst-icon-admonition-important: var(--pst-icon-exclamation-circle);
--pst-icon-admonition-seealso: var(--pst-icon-share);
--pst-icon-admonition-todo: var(--pst-icon-pencil);
}




/* Consent dialog */
.consent {
position: fixed;
right: 0;
bottom: 0;
max-width: 530px;
padding: 30px 45px 25px;
background: linear-gradient(157deg, #005A78 -18.68%, #2E8894 95.63%);
color: #fff;
}
.consent p {
margin-bottom: 0.5em;
color: #fff;
font-size: 14px;
font-weight: 300;
}
.consent button {
padding-left: 1em;
padding-right: 1em;
margin-left: .5em;
margin-right: .5em;
background-color: #48A2AE;
border-radius: 12px;
border-width: 0;
color: #fff;
}
.consent a:link {
margin-left: .5em;
color: #ffffff;
}
.consent a:visited {
color: lightgrey;
}
.consent a:hover {
color: lightgrey;
}
.consent a:active {
color: #d9d9d9;
}
2 changes: 0 additions & 2 deletions source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@
{# Adds extra headers to the template, such as custom styling #}
{% block extrahead %}
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:ital,wght@0,400;0,700;1,400;1,700&family=IBM+Plex+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" />

{% endblock %}

{% block footer %}
{% include "sidenav.html" %}
{% include "copyright.html" %}
{% include "footer.html" %}
{% include "analytics.html" %}
Expand Down
71 changes: 0 additions & 71 deletions source/_templates/navbar-menu.html

This file was deleted.

17 changes: 0 additions & 17 deletions source/_templates/sidenav.html

This file was deleted.

2 changes: 1 addition & 1 deletion source/academy/custom-errors.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:orphan:

.. include:: ../mainnet/smart-contracts/guides/custom-errors.rst
.. include:: ../mainnet/docs/smart-contracts/guides/custom-errors.rst

.. include:: ../mainnet/variables.rst
95 changes: 92 additions & 3 deletions source/mainnet/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
"show_toc_level": 2,
"navigation_depth": 5,
"navbar_start": ["navbar-logo"],
"navbar_center": ["navbar-menu"],
"navbar_center": ["navbar-nav"],
"navbar_end": ["navbar-icon-links"],
"secondary_sidebar_items": ["page-toc", "edit-this-page"],
"article_footer_items": ["footer-article"],
Expand Down Expand Up @@ -265,7 +265,7 @@
html_static_path = ["../_static"]

html_css_files = [
"css/style.css",
"css/custom.css",
"css/tippy.css",
]

Expand Down Expand Up @@ -377,4 +377,93 @@
"./net/references/grpc": "net/references/grpc2.html",
"./en/mainnet/smart-contracts/guides/contract-testing-guides": "./en/mainnet/smart-contracts/guides/integration-test-contract",
"./en/mainnet/smart-contracts/best-practices/index": "./en/mainnet/smart-contracts/best-practices/development",
}
"./net/smart-contracts/guides/quick-start": "docs/smart-contracts/guides/quickstart.html",
"./net/smart-contracts/guides/deploy-module": "docs/smart-contracts/guides/deploy-module.html",
"./net/concepts/id-accounts": "docs/protocol/id.accounts.html",
"./net/smart-contracts/general/introduction": "docs/smart-contracts/introduction.html",
"./net/smart-contracts/general/contract-instances": "docs/smart-contracts/contract-instances.html",
"./net/smart-contracts/general/contract-lifecycle": "docs/smart-contracts/contract-lifecycle.html",
"./net/smart-contracts/general/contract-module": "docs/smart-contracts/contract-module.html",
"./net/smart-contracts/general/contract-schema": "docs/smart-contracts/contract-schema.html",
"./net/smart-contracts/general/develop-contracts": "docs/smart-contracts/develop-contracts.html",
"./net/smart-contracts/general/images/smart-contract-lifecycle.png": "docs/smart-contracts/images/smart-contract-lifecycle.png",
"./net/references/manage-accounts": "docs/protocol/manage-accounts.html",
"./net/images/concepts/account-creation.png": "docs/protocol/images/account-creation.png",
"./net/smart-contracts/guides/setup-tools": "docs/smart-contracts/guides/build-contract.html",
"./net/smart-contracts/guides/setup-contract": "docs/smart-contracts/guides/setup-contract.html",
"./net/smart-contracts/guides/compile-module": "docs/smart-contracts/guides/compile-module.html",
"./net/smart-contracts/guides/build-schema": "docs/smart-contracts/guides/build-schema.html",
"./net/smart-contracts/guides/no-std": "docs/smart-contracts/guides/no-std.html",
"./net/smart-contracts/guides/fallback-entrypoints": "docs/smart-contracts/guides/fallback-entrypoints.html",
"./net/smart-contracts/guides/upgradeable-contract": "docs/smart-contracts/guides/upgradeable-contract.html",
"./net/smart-contracts/guides/json-params": "docs/smart-contracts/guides/json-params.html",
"./net/smart-contracts/guides/factory-pattern": "docs/smart-contracts/guides/factory-pattern.html",
"./net/smart-contracts/guides/unit-test-contract": "docs/smart-contracts/guides/unit-test-contract.html",
"./net/smart-contracts/guides/development": "docs/smart-contracts/guides/development.html",
"./net/smart-contracts/guides/costs": "docs/smart-contracts/guides/costs.html",
"./net/guides/company-identities": "docs/protocol/company-identities.html",
".net/images/company-id-request.png": "docs/protocol/images/company-id-request.png",
".net/images/company-id-create.png": "docs/protocol/images/company-id-create.png",
".net/images/company-id-acct-keys.png": "docs/protocol/images/company-id-acct-keys.png",
".net/images/company-id-recover.png": "docs/protocol/images/company-id-recover.png",
".net/concepts/concepts-transactions": "docs/protocol/concepts-transactions.html",
".net/concepts/concepts-baker": "docs/protocol/concepts-baker.html",
".net/concepts/concepts-delegation": "docs/protocol/concepts-delegation.html",
".net/images/concepts/baker-process1.png": "docs/protocol/images/baker-process1.png",
".net/images/concepts/baker-process2.png": "docs/protocol/images/baker-process2.png",
".net/smart-contracts/guides/initialize-contract": "docs/smart-contracts/guides/initialize-contract.html",
".net/smart-contracts/guides/interact-instance": "docs/smart-contracts/guides/interact-instance.html",
".net/smart-contracts/guides/inspect-instance": "docs/smart-contracts/guides/inspect-instance.html",
".net/smart-contracts/guides/invoke-instance": "docs/smart-contracts/guides/invoke-instance.html",
".net/guides/baker-pool": "docs/network/baker-pool.html",
".net/guides/baker-windows": "docs/network/baker-windows.html",
".net/nodes/baker-macos": "docs/network/guides/baker-macos.html",
".net/nodes/baker-ubuntu": "docs/network/guides/baker-ubuntu.html",
".net/nodes/baker-docker": "docs/network/guides/baker-docker.html",
".net/guides/become-baker": "docs/network/guides/become-baker.html",
".net/references/concordium-client": "docs/network/concordium-client.html",
".net/references/transactions": "docs/network/transactions.html",
".net/references/query-node": "docs/network/query-node.html",
".net/references/multi-sig": "docs/network/multi-sig.html",
".net/web3-id/index": "docs/network/web3-id/index.html",
".net/web3-id/wallet": "docs/network/web3-id/wallet.html",
".net/web3-id/issuer": "docs/network/web3-id/issuer.html",
".net/guides/create-proofs": "docs/network/guides/create-proofs.html",
".net/web3-id/concordia": "docs/network/web3-id/concordia.html",
".net/guides/run-local-chain": "docs/network/guides/run-local-chain.html",
".net/guides/low-code-nft-marketplace/introduction": "docs/network/low-code-nft-marketplace/introduction.html",
".net/guides/low-code-nft-marketplace/marketplace": "docs/network/low-code-nft-marketplace/marketplace.html",
".net/guides/low-code-nft-marketplace/minting-tool": "docs/network/low-code-nft-marketplace/minting-tool.html",
".net/indexers/intro": "docs/network/indexers/intro.html",
".net/indexers/suoquery": "docs/network/indexers/subquery.html",
".net/nodes/node-requirements": "docs/network/nodes/node-requirements.html",
".net/guides/run-node-ubuntu": "docs/network/nodes/run-node-ubuntu.html",
".net/nodes/run-node-ubuntu": "docs/network/nodes/run-node-ubuntu-testnet.html",
".net/nodes/troubleshoot-ubuntu": "docs/network/nodes/troubleshoot-ubuntu.html",
".net/guides/run-node-macos": "docs/network/nodes/run-node-macos.html",
".net/nodes/troubleshoot-macos": "docs/network/nodes/troubleshoot-macos.html",
".net/guides/run-nodes-windows": "docs/network/nodes/rin-nodes-windows.html",
".net/nodes/node-runner-servide-configuration": "docs/network/nodes/node-runner-service-configuration.html",
".net/nodes/troubleshoot-windows": "docs/network/nodes/troubleshoot-windows.html",
".net/guides/run-node": "docs/network/nodes/run-node.html",
".net/nodes/troubleshoot-docker": "docs/network/nodes/troubleshoot-docker.html",
".net/nodes/ubuntu": "docs/network/nodes/run-node-ubuntu.html",
".net/nodes/macos": "docs/network/nodes/run-node-macos.html",
".net/nodes/windows": "docs/network/nodes/run-node-windows.html",
".net/nodes/docker": "docs/network/nodes/run-node.html",
".net/release-notes/release-notes-lp": "docs/release-notes/release-notes-lp.html",
".net/release-notes/release-notes-mainnet": "docs/release-notes/release-notes-mainnet.html",
".net/release-notes/release-notes": "docs/release-notes/release-notes.html",
".net/installation/downloads": "docs/installation/downloads.html",
".net/installation/previous-node-downloads": "docs/installation/previous-node-downloads.html",
".net/installation/verification-instructuions": "docs/installation/verification-instructions.html",
".net/installation/cargo-verification-instructions/cargo-linux": "docs/installation/cargo-verification-instructions/cargo-linux.html",
".net/installation/cdw-verification-instructions/cdw-appimage": "docs/installation/cdw-verification-instructions/cdw-appimage.html",
".net/installation/cdw-verification-instructions/cdw-deb": "docs/installation/cdw-verification-instructions/cdw-deb.html",
".net/installation/cdw-verification-instructions/cdw-rpm": "docs/installation/cdw-verification-instructions/cdw-rpm.html",
".net/installation/client-verification-instructions/client-linux": "docs/installation/client-verification-instructions/client-linux.html",
".net/installation/snippets/delegation-faq": "docs/help/delegation-faq.html",
".net/resources/glossary": "docs/resources/glossary.html"


}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. include:: ../../variables.rst
.. _delegation-faq:
.. _delegation-faq-old:

Delegation and validation FAQ
=============================
Expand Down
9 changes: 9 additions & 0 deletions source/mainnet/docs/help-and-faq/faqs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
===============
FAQs
===============

.. toctree::
:hidden:
:maxdepth: 1

./delegation-faq
File renamed without changes
Loading