GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
nym-node-1.1.9
nym/documentation/docs/next.config.js
T
mx d6599b2933 [DOCs]: New docs framework (#5017) 
* started todo list for rework

* startd long todo list

* startd long todo list

* remove ts docs from ts sdk dir

* started new docs draft

* rearranged code example dir structure

* modified code component filepaths

* first pass rust sdk

* small shift typescript org

* updated todo list

* consolidating images folders in one place

* first pass @ operator docs

* gen updates

* sdk in its own dir

* first pass developers structure

* first pass network structure

* structure

* add licensing

* moved old docs -> old_docs dir for clarity when devving

* moving around new docs - think this is the final dir structure

* updated todo list

* new autodoc version (#4781)

* Update rework_todo.md

* quick first sketch of landing page

* rework of structure of developers

* added arch and concepts stubs

* add new bits to todo list

* new list

* tweak to overview

* mixnet node overview

* tweak overview

* first pass new arch

* first pass concepts

* first pass traffic

* more network docs

* moved some chain files to the dev portal stubs

* removed old reference to archive

* note to client

* concepts 2nd pass

* crypto first proper pass, sphinx

* stub for not p2p

* structure change

* traffic 2nd pass

* misc

* hid root index

* overhaul arch

* overhaul arch

* add links + tweaks

* update todo list

* updating nyx section

* added zknym docs

* added zknym docs

* note on where to find deployed info

* smart contracts done

* started moving integrations docs over from ts sdk

* pass @ integration page

* todo for the tldr overview

* added ffi stub files

* updated todo list

* move sdks to developers

* initial pass at new clients overview for developers

* rework intro

* add echo serv to tools

* sidebar autocollapse

* integration overview work + tools

* concepts overview for devporta

* stub

* more for networking pages

* added to concepts in dev portal

* updated arch

* crypto overview page

* typo fix

* add credential stub

* first pass concepts done

* start reorg of rust sdk docs

* reorg + added FFI table

* added no scroll to inline code

* finished ffi overview page

* first pass @ rest of rust sdk doc

* first pass ffi

* tweaks

* added testnet example + note to custom topology example overview

* stripped unnecessary stuff from TS

* tweaks to ffi

* updated faq

* first pass tcpproxy

* commit before moving image dir

* moved images/ to correct place

* started on client redo

* chain first pass

* moved cli wallet out of tools

* first pass new ws client

* new chain info, left todo links in

* links

* more links

* chain registry

* added echo server to tools

* rust sdk links

* ts sdk links

* final linkchecks

* redo acks diagram as mermaid

* add mermaid flow diagram

* added links for codecs + full flow diagram

* removed todo

* remove forced dark mode

* diagram + concepts overview

* small correction re tcpproxy ffi

* remove diagram title

* new sock5 diagram, minor client docs tweaks

* diagrams

* change order in list

* added note for standalone: can be accessed via sdk

* tweaks

* replaced old diagram with mermaid

* fixed link

* hardcoded import version for the moment

* update deps

* remove test component

* recreated tools dir

* remove tools dir moved to wrong palce

* prebuild and predev script for autodoc commands

* make script own command instead of prebuild

* made code blocks sh

* updated autogenerated docs

* temp

* auto commit generated command files

* add link to autodoc generated files

* updated autodoc for committing changing else exit

* auto commit generated command files

* updated readme

* make subcommand headers smaller

* removed mdbook related scripts

* update readme

* update readme

* removed backups of root meta.json

* cherry pick yana commits + some extra config in theme

* update readme

* update theme: width of page and padding

* some more themeing

* changed erroneous note

* docs redirects first pass

* tweaking

* new pages + rest of redirects for old docs/

* brought in archive + done rewrites for devportal

* cherry pick yana landingpage

* tweaked landing page component

* changed theme of mermaid diagram to match everything else

* updated todo list

* [DOCs]: Operators rework to next.js (#4930)

* initialise operators guides v2

* new introduction page

* add variables csv and page

* add baseurl to allow short path

* add sandbox page

* added building from source page

* add binary pages

* add preliminary steps

* clean preliminary steps dir

* syntax edit

* syntax edit

* add configuration page

* create new proxy configuration page

* create new proxy configuration page

* create bonding.mdx page

* correct images path

* syntax edit

* add new validator setup page

* add api setup page

* add nyx configuration page

* add nym node and maintenance pages

* finish maintenance and add nymvisor conf page

* add manual upgrade page

* add nymvisor upgrade page

* add performance testing page and dir

* add node api check page

* add explore nym scripts page

* add testing pages

* fix menu issue by moving snippets to coomponents

* add all troubleshooting pages

* add general faq page

* add nym node faq page

* add nyx faq page

* revamp legal forum to community counsel and add all pages

* rewire relative paths to new structure

* simplify setup and remove lock file

* syntax fix

* rm package.json

* re add package.json, rm package-lock.json

* removed old books from commit

* address review comments

---------

Co-authored-by: mfahampshire <maxhampshire@pm.me>
Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>

* tweak client links

* also moved matrix images to correct place

* Max/fix links new docs framework (#4989)

* tweak client links
* standardise images in public/
* old images move to public/archive

* rename overview to more descriptive

* links (#4990)

* links
* removed todos
* updated todo list

* minor themeing

* operator redirects

* pick yana's edits: remove specified callout theming

* added todo comments for old ts sdk redirects

* [new/docs/operators]: Create archive section - PR ready to merge (#5004)

* [new-docs/operators] : Fix callout syntax (#5006)

* fix callout syntax from color to type

* correct callout from danger to warning

* update footer

* updated footer

* finalised rewrites

* tweaks to clients and reintroduced old examples page

* update todo

* Max/individual command autodocs (#5015)


* auto commit generated command files

* added to autodoc.sh: build all binaries before running

* autodoc move individual command outputs to components

* Max/individual command autodocs (#5018)


* updated autodoc script

* updated autodoc script for fix + reintroduced gitignore file for generated markdown

* auto commit generated command files

* auto commit generated command files

* added command-outputs to autodoc script

* fix merge conflicts

* repush components

* remove old docs dirs

* auto commit generated command files

* auto commit generated command files

* updated messages paradigm with the standalone proxies

* [NEW-DOCs/operators]: Command output, accordion, api scraping & all final tasks (#5026)

* add custom scripts, create prebuild to import data to pages

* update after latest prebuild

* auto commit generated command files

* add accordion component

* add changbelog page

* add node_api_check outputs

* finish all command outputs

* more accordions beautifications

* finish accordion

* PR ready to go

* address review comments

---------

Co-authored-by: mfahampshire <maxhampshire@pm.me>

* Adjust padding

* Fix responsive design

* cherry pick yana landingpage flex update

* reremove old docs

* added dependencies to readme

* pushing build attempt changes

* fix merge errors, path errors, dump uselss dinosaurs - BUILT THE F*N DOCS w success

* moved prebuild to its own script

* generate timenow

* auto commit generated command files

* remove comment

* auto commit generated command files

* auto commit generated command files

* auto commit generated command files

* build from new configs

* add mdx type as explicit dep

* remove rc from version in package

* change predev script

* update readme with scripts

* update general info

* add license

* auto commit generated command files

* add updated components

* removed old examples page for the moment

* remove old list will reintroduce hidden behind gitignore for future

* reintroduce todo list behind gitignore

* added standalone tcpproxy binary info

* nothing change for redeploy test

* make build standalone

* updated readme

* working on new cd

* remove export

* updated ci/cd for docs

* added ci script for dist

* hide text on laptop wide screen

* add pnpm to ci/cd

* add pnpm version to ci/cd

* add default dir to ci/cd

* change path to script

* update projct name ci

* lint ci branch ignore

* add basePath to next.config.js

* update doc rewrites

* revert basePath addition

* update basePath

* add mobile styles

* fix responsive style

* remove old ts sdk docs workflow

* temp remove autodoc from workspace

* update sidebar for clarity: crypto = cryptography

* ignore documentation in pr-validation workflow

---------

Co-authored-by: Yana <yanok87@users.noreply.github.com>
Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
Co-authored-by: fmtabbara <fmtabbara@hotmail.co.uk>
2024-11-04 11:42:56 +00:00

586 lines
18 KiB
JavaScript
Raw Permalink Blame History

// const path = require('path');
// const CopyPlugin = require('copy-webpack-plugin');
const withNextra = require("nextra")({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
});
const nextra = withNextra();
nextra.webpack = (config, options) => {
// generate Nextra's webpack config
const newConfig = withNextra().webpack(config, options);
newConfig.module.rules.push({
test: /\.txt$/i,
use: "raw-loader",
});
// TODO: figure out how to properly bundle WASM and workers with Nextra
// newConfig.plugins.push(
// new CopyPlugin({
// patterns: [
// {
// from: path.resolve(path.dirname(require.resolve('@nymproject/mix-fetch/package.json')), '*.wasm'),
// to: '[name][ext]',
// context: path.resolve(__dirname, 'out'),
// },
// {
// from: path.resolve(path.dirname(require.resolve('@nymproject/mix-fetch/package.json')), '*worker*.js'),
// to: '[name][ext]',
// context: path.resolve(__dirname, 'out'),
// },
// ],
// }),
// );
return newConfig;
};
const config = {
...nextra,
basePath: "/docs",
async redirects() {
return [
// network docs
{
source: "/",
destination: "/docs",
basePath: false,
permanent: true,
},
{
source: "/docs/architecture/nym-vs-others.html",
destination: "/network/architecture/nym-vs-others",
permanent: true,
},
{
source: "/docs/architecture/traffic-flow.html",
destination: "/network/traffic",
permanent: true,
},
{
source: "/docs/architecture/addressing-system.html",
destination: "/network/traffic/addressing-system",
permanent: true,
},
{
source: "/docs/binaries/pre-built-binaries.html",
destination: "/developers/binaries#building-from-source",
permanent: true,
},
{
source: "/docs/binaries/init-and-config.html",
destination: "/developers/binaries#building-from-source",
permanent: true,
},
{
source: "/docs/binaries/building-nym.html",
destination: "/developers/binaries#building-from-source",
permanent: true,
},
{
source: "/docs/nodes/overview.html ",
destination: "/network/architecture/mixnet/nodes",
permanent: true,
},
{
source: "/docs/wallet/desktop-wallet.html",
destination:
"https://github.com/nymtech/nym/tree/master/nym-wallet#installation-prerequisites---linux--mac",
permanent: true,
},
{
source: "/docs/wallet/cli-wallet.html",
destination: "/developers/chain/cli-wallet",
permanent: true,
},
{
source: "/docs/explorers/mixnet-explorer.html",
destination:
"https://github.com/nymtech/nym/tree/master/explorer#nym-network-explorer",
permanent: true,
},
{
source: "/docs/nyx/interacting-with-chain.html",
destination: "/developers/chain",
permanent: true,
},
{
source: "/docs/nyx/smart-contracts.html",
destination: "/network/architecture/nyx/smart-contracts",
permanent: true,
},
{
source: "/docs/nyx/mixnet-contract.html",
destination:
"/network/architecture/nyx/smart-contracts/mixnet-contract",
permanent: true,
},
{
source: "/docs/nyx/vesting-contract.html",
destination:
"/network/architecture/nyx/smart-contracts/vesting-contract",
permanent: true,
},
{
source: "/docs/nyx/rpc-node.html",
destination: "/developers/chain/rpc-node",
permanent: true,
},
{
source: "/docs/nyx/ledger-live.html",
destination: "/developers/chain/ledger-live",
permanent: true,
},
{
source: "/docs/coconut.html",
destination: "/network/cryptography/zk-nym",
permanent: true,
},
{
source: "/docs/nyx/bandwidth-credentials.html",
destination: "/network/cryptography/zk-nym",
permanent: true,
},
{
source: "/docs/tools/nym-cli.html",
destination: "/developers/tools/nym-cli",
permanent: true,
},
{
source: "/docs/coc.html",
destination: "/network/coc",
permanent: true,
},
{
source: "/docs/licensing.html",
destination: "/network/licensing",
permanent: true,
},
// dev docs
{
source: "/developers/clients-overview.html",
destination: "/developers/clients",
permanent: true,
},
{
source: "/developers/sdk/rust/rust.html",
destination: "/developers/rust",
permanent: true,
},
{
source: "/developers/sdk/rust/message-types.html",
destination: "/developers/rust/mixnet/message-types",
permanent: true,
},
{
source: "/developers/sdk/rust/message-helpers.html",
destination: "/developers/rust/mixnet/message-helpers",
permanent: true,
},
{
source: "/developers/sdk/rust/troubleshooting.html",
destination: "/developers/rust/mixnet/troubleshooting",
permanent: true,
},
{
source: "/developers/sdk/rust/examples.html",
destination: "/developers/rust/mixnet/examples",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/simple.html",
destination: "/developers/rust/mixnet/examples/simple",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/keys.html",
destination: "/developers/sdk/rust/examples/keys.html",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/storage.html",
destination:
"/developers/rust/mixnet/examples/builders/builder-with-storage",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/surbs.html",
destination: "/developers/rust/mixnet/examples/surbs",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/custom-network.html",
destination: "/developers/rust/mixnet/examples/custom-topology",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/socks.html",
destination: "/developers/rust/mixnet/examples/socks",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/split-send.html",
destination: "/developers/rust/mixnet/examples/split-send",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/credential.html",
destination: "/developers/rust/mixnet",
permanent: true,
},
{
source: "/developers/sdk/rust/examples/cargo.html",
destination: "/developers/rust/importing",
permanent: true,
},
{
source: "/developers/sdk/typescript.html",
destination: "/developers/typescript",
permanent: true,
},
{
source: "/developers/binaries/pre-built-binaries.html",
destination: "/developers/binaries#pre-built-binaries",
permanent: true,
},
{
source: "/developers/binaries/building-nym.html",
destination: "/developers/binaries",
permanent: true,
},
{
source: "/developers/clients/websocket-client.html",
destination: "/developers/clients/websocket",
permanent: true,
},
{
source: "/developers/clients/websocket/setup.html",
destination: "/developers/clients/websocket/setup",
permanent: true,
},
{
source: "/developers/clients/websocket/config.html",
destination: "/developers/clients/websocket/config",
permanent: true,
},
{
source: "/developers/clients/websocket/usage.html",
destination: "/developers/clients/websocket/usage",
permanent: true,
},
{
source: "/developers/clients/websocket/examples.html",
destination: "/developers/clients/websocket/examples",
permanent: true,
},
{
source: "/developers/clients/socks5-client.html",
destination: "/developers/clients/socks5",
permanent: true,
},
{
source: "/developers/clients/socks5/setup.html",
destination: "/developers/clients/socks5#client-setup",
permanent: true,
},
{
source: "/developers/clients/socks5/usage.html",
destination: "/developers/clients/socks5#using-your-socks5-client",
permanent: true,
},
{
source: "/developers/clients/webassembly-client.html",
destination: "/developers/clients/webassembly-client",
permanent: true,
},
{
source: "/developers/tutorials/coming-soon.html",
destination: "/developers/rust#",
permanent: true,
},
{
source: "/developers/integrations/integration-options.html",
destination: "/developers/integrations",
permanent: true,
},
{
source: "/developers/faq/integrations-faq.html",
destination: "/developers/integrations",
permanent: true,
},
{
source: "/developers/coc.html",
destination: "/developers/coc",
permanent: true,
},
{
source: "/developers/licensing.html",
destination: "/developers/licensing",
permanent: true,
},
{
source: "/developers/nymvpn/intro.html",
destination: "/developers/archive/nymvpn",
permanent: true,
},
{
source: "/developers/nymvpn/cli.html",
destination: "/developers/nymvpn/cli",
permanent: true,
},
{
source: "/developers/archive/nym-connect.html",
destination: "/developers/archive/nym-connect",
permanent: true,
},
{
source: "/developers/examples/custom-services.html",
destination: "/developers/rust/mixnet/other-examples#services",
permanent: true,
},
{
source: "/developers/examples/browser-only.html",
destination: "/developers/rust/mixnet/other-examples#browser-only",
permanent: true,
},
{
source: "/developers/examples/using-nrs.html",
destination: "/developers/rust/mixnet/other-examples",
permanent: true,
},
{
source: "/developers/examples/monorepo-examples.html",
destination: "/developers/rust/mixnet/other-examples",
permanent: true,
},
{
source: "/developers/integrations",
destination: "/developers/integrations/payment-integration.html",
permanent: true,
},
// {
// source: "",
// destination: "",
// permanent: true,
// },
// operators:
// specific urls that have changed
{
source: "/operators/nodes/wallet-preparation.html",
destination: "/operators/nodes/preliminary-steps/wallet-preparation",
permanent: true,
},
{
source: "/operators/nodes/vps-setup.html",
destination: "/operators/nodes/preliminary-steps/vps-setup",
permanent: true,
},
{
source: "/operators/nodes/proxy-configuration.html",
destination:
"/operators/nodes/nym-node/configuration/proxy-configuration",
permanent: true,
},
{
source: "/operators/nodes/bonding.html",
destination: "/operators/nodes/nym-node/bonding",
permanent: true,
},
{
source: "/operators/nodes/nym-api.html",
destination: "/operators/nodes/validator-setup/nym-api",
permanent: true,
},
{
source: "/operators/nodes/nyx-configuration.html",
destination: "/operators/nodes/validator-setup/nyx-configuration",
permanent: true,
},
{
source: "/operators/nodes/manual-upgrade.html",
destination: "/operators/nodes/maintenance/manual-upgrade",
permanent: true,
},
{
source: "/operators/nodes/nymvisor-upgrade.html",
destination: "/operators/nodes/maintenance/nymvisor-upgrade",
permanent: true,
},
{
source: "/operators/testing/performance.html",
destination: "/operators/nodes/performance-and-testing",
permanent: true,
},
{
source: "/operators/testing/gateway-probe.html",
destination: "/operators/nodes/performance-and-testing/gateway-probe",
permanent: true,
},
{
source: "/operators/testing/node-api-check.html",
destination: "/operators/nodes/performance-and-testing/node-api-check",
permanent: true,
},
{
source: "/operators/testing/prometheus-grafana.html",
destination:
"/operators/nodes/performance-and-testing/prometheus-grafana",
permanent: true,
},
{
source: "/operators/testing/explorenym-scripts.html",
destination:
"/operators/nodes/performance-and-testing/prometheus-grafana/explorenym-scripts",
permanent: true,
},
{
source: "/operators/legal/community-counsel.html",
destination: "/operators/community-counsel",
permanent: true,
},
{
source: "/operators/legal/exit-gateway.html",
destination: "/operators/community-counsel/exit-gateway",
permanent: true,
},
{
source: "/operators/legal/isp-list.html",
destination: "/operators/community-counsel/isp-list",
permanent: true,
},
{
source: "/operators/legal/jurisdictions.html",
destination: "/operators/community-counsel/jurisdictions",
permanent: true,
},
{
source: "/operators/legal/swiss.html",
destination: "/operators/community-counsel/jurisdictions/swiss",
permanent: true,
},
{
source: "/operators/legal/united-states.html",
destination: "/operators/community-counsel/jurisdictions/united-states",
permanent: true,
},
{
source: "/operators/legal/landing-pages.html",
destination: "/operators/community-counsel/landing-pages",
permanent: true,
},
{
source: "/operators/legal/add-content.html",
destination: "/operators/community-counsel/add-content",
permanent: true,
},
// since the filepaths are mostly the same, we otherwise just match on old URLs that end with .html
{
source: "/:path*.html",
destination: "/:path*",
permanent: false,
},
// TODO these need to go in the config of the existing deployed ts sdk docs to redirect from there
// these assume source basePath = sdk.nymtech.net
// {
// source: "/intro",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript",
// permanent: true,
// },
// {
// source: "/overview",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/overview",
// permanent: true,
// },
// {
// source: "/integrations",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/integrations",
// permanent: true,
// },
// {
// source: "/installation",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/installation",
// permanent: true,
// },
// {
// source: "/start",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/start",
// permanent: true,
// },
// {
// source: "/examples/mix-fetch",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>developers/typescript/examples/mix-fetch",
// permanent: true,
// },
// {
// source: "/examples/mixnet",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>//developers/typescript/examples/mixnet",
// permanent: true,
// },
// {
// source: "/examples/nym-smart-contracts",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/examples/nym-smart-contracts",
// permanent: true,
// },
// {
// source: "/examples/cosmos-kit",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>//developers/typescript/examples/cosmos-kit",
// permanent: true,
// },
// {
// source: "/playground/mixfetch",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/playground/mixfetch",
// permanent: true,
// },
// {
// source: "/playground/traffic",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/playground/traffic",
// permanent: true,
// },
// {
// source: "/playground/mixnodes",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/playground/mixnodes",
// permanent: true,
// },
// {
// source: "/playground/wallet",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/typescript/playground/wallet",
// permanent: true,
// },
// {
// source: "/playground/cosmos-kit",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/playground/cosmos-kit",
// permanent: true,
// },
// {
// source: "/bundling/bundling",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/bundling/bundling",
// permanent: true,
// },
// {
// source: "/bundling/esbuild",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/bundling/esbuild",
// permanent: true,
// },
// {
// source: "/bundling/webpack",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/bundling/webpack",
// permanent: true,
// },
// {
// source: "/FAQ/general",
// destination: "https://www.<TODO_EDIT_DESTINATION_BASE>/developers/typescript/FAQ",
// permanent: true,
// },
];
},
images: {
unoptimized: true,
},
transpilePackages: ["@nymproject/contract-clients"],
};
module.exports = config;
Reference in New Issue View Git Blame Copy Permalink