From c5807f23da00198337e308675425969b89fb7dd4 Mon Sep 17 00:00:00 2001 From: crypblizz <45455218+crypblizz8@users.noreply.github.com> Date: Thu, 26 Sep 2024 11:36:37 +0200 Subject: [PATCH 1/2] chore: rm extra content --- docs/python-client.md | 71 ------------------------------------------- 1 file changed, 71 deletions(-) diff --git a/docs/python-client.md b/docs/python-client.md index 3950d4b..f9479d3 100644 --- a/docs/python-client.md +++ b/docs/python-client.md @@ -4,75 +4,4 @@ import TabItem from '@theme/TabItem'; # Python Client -[py-nillion-client](https://pypi.org/project/py-nillion-client/) is a Python client for building on top of the Nillion Network. It can be used to manage Nada programs, store and retrieve secrets, and run computations. - -## Installation - -Install the [py-nillion-client](https://pypi.org/project/py-nillion-client/) PyPi package in an existing Python application - -```bash -pip install --upgrade py-nillion-client -``` - -## Usage - -### Import Python Client - -```python3 -import py_nillion_client as nillion -``` - -### Initialize a client - -Initialize an instance of the NillionClient connected to the Nillion Network using [helpers](https://github.com/NillionNetwork/nillion-python-starter/tree/main/helpers) from [nillion-python-starter](https://github.com/NillionNetwork/nillion-python-starter) - - - -```python -import os -from dotenv import load_dotenv # pip install python-dotenv -from helpers.nillion_client_helper import create_nillion_client -from helpers.nillion_keypath_helper import getUserKeyFromFile, getNodeKeyFromFile - -# Loads environment variables from the .env file -load_dotenv() - -def main(): - userkey = getUserKeyFromFile(os.getenv("NILLION_USERKEY_PATH_PARTY_1")) - nodekey = getNodeKeyFromFile(os.getenv("NILLION_NODEKEY_PATH_PARTY_1")) - # Initialize Nillion Client instance - client = create_nillion_client(userkey, nodekey) - # Print the user id - print(client.user_id) - -if __name__ == "__main__": - main() -``` - - - -```python reference showGithubLink -https://github.com/NillionNetwork/nillion-python-starter/blob/main/helpers/nillion_client_helper.py -``` - - - -```python reference showGithubLink -https://github.com/NillionNetwork/nillion-python-starter/blob/main/helpers/nillion_keypath_helper.py -``` - - - -```python reference showGithubLink -https://github.com/NillionNetwork/nillion-python-starter/blob/main/.env.sample -``` - - -```python reference showGithubLink -https://github.com/NillionNetwork/nillion-python-starter/blob/main/bootstrap-local-environment.sh -``` - - -## Resources - From 3088218d8b00e857ebfb130cdeed58ad36b027ca Mon Sep 17 00:00:00 2001 From: crypblizz <45455218+crypblizz8@users.noreply.github.com> Date: Thu, 26 Sep 2024 17:46:27 +0200 Subject: [PATCH 2/2] chore: add extra config + fix dead links --- docs/guide-testnet-connect.md | 2 +- docs/js-quickstart.md | 2 +- docs/quickstart-testnet.md | 2 +- docusaurus.config.js | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/guide-testnet-connect.md b/docs/guide-testnet-connect.md index 89f5aeb..7909470 100644 --- a/docs/guide-testnet-connect.md +++ b/docs/guide-testnet-connect.md @@ -3,7 +3,7 @@ import SupportedWallets from './\_testnet_supported_wallets.mdx'; # Creating a Nillion Wallet -Create a Nillion wallet to connect to the [Nillion Testnet](/network#nillion-testnet-coordination-layer) and access your assets. +Create a Nillion wallet to connect to the [Nillion Testnet](/network) and access your assets. ## Supported Wallets diff --git a/docs/js-quickstart.md b/docs/js-quickstart.md index 9ebaffd..5f40f91 100644 --- a/docs/js-quickstart.md +++ b/docs/js-quickstart.md @@ -299,7 +299,7 @@ You've successfully build your first blind app by writing a Nada program, storin - reading about [Nillion concepts](/concepts) and the [Nada Language](nada-lang) - learning how to interact with and manage programs, secrets, and permissions on the Nillion Network with [Nillion Client](/js-client) -- challenging yourself to create a page that solves the [Millionaires Problem](/multi-party-computation#classic-scenario-the-millionaires-problem) +- challenging yourself to create a page that solves the [Millionaires Problem](/multi-party-computation#applied-mpc) :::tip diff --git a/docs/quickstart-testnet.md b/docs/quickstart-testnet.md index 1f7bcc7..07351a0 100644 --- a/docs/quickstart-testnet.md +++ b/docs/quickstart-testnet.md @@ -56,4 +56,4 @@ https://github.com/NillionNetwork/cra-nillion/blob/main/vercel.json - reading about [Nillion concepts](/concepts) and the [Nada Language](nada-lang) - learning how to interact with and manage programs, secrets, and permissions on the Nillion Network with [Nillion Client](/js-client) -- challenging yourself to create a page that solves the [Millionaires Problem](/multi-party-computation#classic-scenario-the-millionaires-problem) +- challenging yourself to create a page that solves the [Millionaires Problem](/multi-party-computation#applied-mpc) diff --git a/docusaurus.config.js b/docusaurus.config.js index e54c8e0..ad64277 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -22,8 +22,8 @@ const config = { trailingSlash: false, onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - + onBrokenMarkdownLinks: 'throw', + onBrokenAnchors: 'throw', // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you // may want to replace "en" with "zh-Hans".