d6599b2933
* 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>
144 lines
4.6 KiB
TypeScript
144 lines
4.6 KiB
TypeScript
import React from "react";
|
|
import { Box, Grid, Typography } from "@mui/material";
|
|
import useMediaQuery from "@mui/material/useMediaQuery";
|
|
import { useTheme } from "@mui/material/styles";
|
|
|
|
import Image from "next/image";
|
|
import Link from "next/link";
|
|
|
|
import networkDocs from "../public/images/landing/network-docs.png";
|
|
import developerDocs from "../public/images/landing/developer-docs.png";
|
|
import sdkDocs from "../public/images/landing/sdk-docs.png";
|
|
import operatorGuide from "../public/images/landing/operator-guide.png";
|
|
import { t } from "nextra/dist/types-c8e621b7";
|
|
// import networkDocs from "./images/network-docs.png";
|
|
// import developerDocs from "./images/developer-docs.png";
|
|
// import sdkDocs from "./images/sdk-docs.png";
|
|
// import operatorGuide from "./images/operator-guide.png";
|
|
|
|
export const LandingPage = () => {
|
|
const theme = useTheme();
|
|
const isTablet = useMediaQuery(theme.breakpoints.up("md"));
|
|
const isDesktop = useMediaQuery(theme.breakpoints.up("xl"));
|
|
|
|
const squares = [
|
|
{
|
|
text: "Network Docs",
|
|
description: "Architecture, crypto systems, and how the Mixnet works",
|
|
href: "/network",
|
|
icon: developerDocs,
|
|
},
|
|
{
|
|
text: "Operator Guides",
|
|
description:
|
|
"Guides and maintenance: if you want to run a node, start here",
|
|
|
|
href: "/operators/introduction",
|
|
icon: operatorGuide,
|
|
},
|
|
{
|
|
text: "Developer Portal",
|
|
description:
|
|
"Conceptual overview, clients, and tools for developers and integrations",
|
|
|
|
href: "/developers",
|
|
icon: networkDocs,
|
|
},
|
|
{
|
|
text: "SDKs",
|
|
description: "Rust and Typescript SDK docs",
|
|
|
|
href: "/developers/rust",
|
|
icon: sdkDocs,
|
|
},
|
|
];
|
|
|
|
const shortenDescription = (description: string) => {
|
|
return description.slice(0, 18) + "...";
|
|
};
|
|
|
|
return (
|
|
<Box margin={"0 auto"}>
|
|
<Typography variant="h2" mb={6}>
|
|
Nym Docs
|
|
</Typography>
|
|
|
|
<Typography mb={10}>
|
|
Nym is a privacy platform. It provides strong network-level privacy
|
|
against sophisticated end-to-end attackers, and anonymous access control
|
|
using blinded, re-randomizable, decentralized credentials. Our goal is
|
|
to allow developers to build new applications, or upgrade existing apps,
|
|
with privacy features unavailable in other systems.
|
|
</Typography>
|
|
<Grid container border={"1px solid #262626"}>
|
|
{squares.map((square, index) => (
|
|
<Grid
|
|
item
|
|
key={index}
|
|
xs={12}
|
|
lg={6}
|
|
padding={{ xs: 3, xl: 4 }}
|
|
width={"100%"}
|
|
sx={{
|
|
borderBottom: {
|
|
xs: index < 3 ? "1px solid #262626" : "none",
|
|
lg: index === 0 || index === 1 ? "1px solid #262626" : "none",
|
|
},
|
|
borderRight: {
|
|
md: index === 0 || index === 2 ? "1px solid #262626" : "none",
|
|
},
|
|
}}
|
|
>
|
|
<Link href={square.href} target="_blank" rel="noopener noreferrer">
|
|
<Box
|
|
display={"flex"}
|
|
gap={{ xs: 3, xl: 4 }}
|
|
height={"100%"}
|
|
flexDirection={{ xs: "column", sm: "row" }}
|
|
alignItems={{ xs: "center" }}
|
|
>
|
|
<Image
|
|
src={square.icon}
|
|
alt={square.text}
|
|
width={isDesktop ? 180 : isTablet ? 140 : 180}
|
|
height={isDesktop ? 134 : isTablet ? 90 : 134}
|
|
/>
|
|
<Box
|
|
display={"flex"}
|
|
flexDirection={"column"}
|
|
justifyContent={"space-between"}
|
|
alignItems={{ xs: "center", sm: "flex-start" }}
|
|
flexGrow={1}
|
|
height={"100%"}
|
|
>
|
|
<Typography variant="h5" sx={{ fontWeight: 600 }}>
|
|
{square.text}
|
|
</Typography>
|
|
|
|
<Typography
|
|
variant="body1"
|
|
textAlign={{ xs: "center", sm: "left" }}
|
|
sx={{
|
|
color: "#909195",
|
|
display: {
|
|
lg: "none",
|
|
xl: "block",
|
|
},
|
|
}}
|
|
>
|
|
{square.description}
|
|
</Typography>
|
|
|
|
<Typography sx={{ color: "#ff6600", fontWeight: 600 }}>
|
|
Open
|
|
</Typography>
|
|
</Box>
|
|
</Box>
|
|
</Link>
|
|
</Grid>
|
|
))}
|
|
</Grid>
|
|
</Box>
|
|
);
|
|
};
|