Skip to content

Total reorganization: New home page, redesigned flow with subdocs for each persona,updated most content for AVS and added new content for blueprints and services, New Resources page, Updated references to network name, release versions for mainnet, and removed auto-generate keys guidance. #35

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

Merged
merged 63 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
eafa450
rebased
thomivy Apr 10, 2024
ac8f28d
fixed link and formatting
thomivy Apr 10, 2024
be17153
syntax error fix
thomivy Apr 10, 2024
4928871
Updated Identity page with new details on generals and Registrar indices
thomivy Apr 30, 2024
a42b855
fixed governance links and added direct links in sidebar to Democracy…
thomivy May 1, 2024
73910e5
added blueprint intro page under Services
thomivy May 1, 2024
8715c12
moved interface links to relevant pages and removed standalone stub
thomivy May 2, 2024
780039f
Merge branch 'main' into claims-image-improvements
shekohex May 5, 2024
9091d4c
added dwellir rpc to config card
thomivy May 6, 2024
a80f6f7
switched header logo to send to docs homepage
thomivy May 7, 2024
d85fe73
removed redirect to /docs in netflify.toml
thomivy May 7, 2024
731d3e9
removed /docs in url
thomivy May 7, 2024
eebbc25
fixed gremlin character
thomivy May 7, 2024
95ded3b
reeng'd navbar
thomivy May 7, 2024
caf92bd
created new subdocs with own navigation
thomivy May 7, 2024
95a5c92
added blueprints guide and moved services to developer subdoc
thomivy May 7, 2024
84b5ad5
created new resources page and subdoc
thomivy May 7, 2024
386774c
created new restake subdoc and index
thomivy May 7, 2024
7111b37
created new network subdoc and index, merged governance into it
thomivy May 7, 2024
61ffc02
created new developer subdoc, merged pallets into it
thomivy May 7, 2024
a4531c7
merged tokenomics into network subdoc
thomivy May 7, 2024
38c867c
restructured node materials and services guides into the Operators su…
thomivy May 7, 2024
4d0dc55
deleted all old structure
thomivy May 7, 2024
0ca434f
fixerd stop-color to stopColor
thomivy May 7, 2024
a3daa1f
fixed clip-path to clipPath
thomivy May 7, 2024
737e6f0
Installed next/third-party-tools and implemented Google Analytics
thomivy May 7, 2024
0478e2a
removed nonfunct index pages for subdocs
thomivy May 7, 2024
cfeeb03
updated blueprint with drew's forum post content
thomivy May 7, 2024
3766ce1
removed nonfunctional sidebar feature
thomivy May 7, 2024
6748bc0
added new navbar with subdocs
thomivy May 7, 2024
976af84
added restaking toplevel page and fixed bug in network overview
thomivy May 7, 2024
135fc29
Fixed gremlin characters, fixed various path issues, implemented new …
thomivy May 9, 2024
aec6899
replaced navbar socials with launch app button
thomivy May 9, 2024
7a3170a
tested katex mdx interaction
thomivy May 9, 2024
ccca42b
delete unused file
thomivy May 9, 2024
d4c1b9d
link fixes
thomivy May 9, 2024
e0182a4
removed gremlin characters
thomivy May 9, 2024
fe81c4e
link fixes
thomivy May 9, 2024
ad21bcf
link fixes
thomivy May 9, 2024
4a1db1e
link fix
thomivy May 9, 2024
3d6396b
prettier
thomivy May 9, 2024
a133d6b
fix landign graphic
thomivy May 9, 2024
290ffe3
img fix
thomivy May 9, 2024
848d0ed
installed shadcn/ui, combined custom.css into global.css and refactored
thomivy May 14, 2024
29e900f
updated hero graphic and serviceflow graphic
thomivy May 14, 2024
b77c947
remade footer with focus on discord funnel, added invite button to to…
thomivy May 14, 2024
24ab484
fixes for global.css
thomivy May 14, 2024
cf2baa3
remade the network infomration table, added copy buttons for rpc endp…
thomivy May 14, 2024
895b4bb
moved or deleted several files no longer in use
thomivy May 14, 2024
e79b211
added new row of cards to landing page per feedback, updated typograp…
thomivy May 14, 2024
4c472ef
created new index page for operators that funnels them to types of no…
thomivy May 14, 2024
d6d0633
linkfix
thomivy May 14, 2024
4edbe22
updated blueprints and moved to top file in developers
thomivy May 14, 2024
cf10097
moved avs file into top of dev and relocated bug reports to dev section
thomivy May 14, 2024
05c1007
added page for nPos, supported assets, concepts
thomivy May 14, 2024
de99bc5
updated restaking docs for AVS
thomivy May 14, 2024
ed1d7c9
updated navs
thomivy May 14, 2024
4c0a1fb
updated network overview for avs
thomivy May 14, 2024
b79817f
gremlin character fix
thomivy May 14, 2024
faef742
Link fix
thomivy May 14, 2024
2146cce
layout tweaks for landing page
thomivy May 14, 2024
cb1c382
tweaked padding on footer
thomivy May 14, 2024
f5cd75e
prettier
thomivy May 14, 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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ if image assets are added to a given section you must provide both a dark and li

**Updating existing content**

1. Navigate to the desired page to update (e.g. `/pages/docs/overview.mdx`)
1. Navigate to the desired page to update (e.g. `/pages/overview.mdx`)
2. Make applicable changes
3. Test those changes locally `yarn install && yarn dev`

**Adding content for existing section**

1. Navigate to the desired documentation section (e.g. `/pages/docs/overview.mdx/`)
1. Navigate to the desired documentation section (e.g. `/pages/overview.mdx/`)
2. Create a new mdx file that represents new page for desired section (e.g. `advanced.mdx`)
3. Write desired content for the new mdx file
4. Update the `_meta.json` file within the section directory to include your new page into the navigation
Expand All @@ -57,7 +57,7 @@ navigation.

2. **Install dependencies**

Navigate into your new sites directory and install all dependencies.
Navigate into your new site's directory and install all dependencies.

```bash
cd tangle-docs/
Expand All @@ -66,7 +66,7 @@ navigation.

3. **Fire the engine**

Navigate into your new sites directory and use the following command to start the development server locally.
Navigate into your new site's directory and use the following command to start the development server locally.

```bash
yarn dev # alias for `yarn start` and `yarn develop`
Expand Down
17 changes: 17 additions & 0 deletions components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "default",
"rsc": false,
"tsx": true,
"tailwind": {
"config": "tailwind.config.js",
"css": "/globals.css",
"baseColor": "zinc",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils"
}
}
28 changes: 28 additions & 0 deletions components/CallToActionCard.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import React from "react";

const CallToActionCard = ({ icon, title, description, link }) => {
return (
<a
href={link}
className="max-w-sm min-h-44 flex items-start hover:bg-gray-100 dark:bg-gray-800 dark:hover:bg-gray-700"
>
<div className="flex items-start">
<div className="mr-4">
{React.cloneElement(icon, { className: "size-7 mt-1.5" })}
</div>
<div>
<div className="flex items-center mb-2">
<h5 className="md:text-lg lg:text-lg text-decoration-line: underline underline-offset-4 font-bold tracking-tight text-linkBlue dark:text-white">
{title}
</h5>
</div>
<p className="text-md font-normal text-gray-900 dark:text-gray-400">
{description}
</p>
</div>
</div>
</a>
);
};

export default CallToActionCard;
4 changes: 3 additions & 1 deletion components/CommonActions.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@
grid-template-rows: auto 1fr auto; /* Three rows: header, content, footer */
margin: 0px 0px 4px 0px;
transition: box-shadow 0.3s ease-in-out;
box-shadow: 0 4px 8px 0 rgb(0 0 0 / 8%), 0 6px 20px 0 rgb(0 0 0 / 1%);
box-shadow:
0 4px 8px 0 rgb(0 0 0 / 8%),
0 6px 20px 0 rgb(0 0 0 / 1%);
overflow: hidden; /* Maintain the border-radius */
background-color: #f5f5f5d1;
}
Expand Down
4 changes: 2 additions & 2 deletions components/CommonActions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ const features = [
Icon: ServerIcon,
title: "Node Deployment",
description: `Want to spin up a full node on the Tangle Network? We've made it easier than ever!`,
href: "/docs/node/docker-node",
href: "/node/docker-node",
action: "Deploy a Docker Node",
},
{
Icon: ServerIcon,
title: "Validators",
description: `Start your journey on Tangle Network. This guide will walk you through the steps to become a validator, ensuring network security and integrity.`,
href: "/docs/node/quickstart/",
href: "/node/quickstart/",
action: "Launch a Quick Validator Node",
},
{
Expand Down
33 changes: 33 additions & 0 deletions components/DiscordBanner.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import React from "react";
import DiscordButton from "./DiscordButton";
import { ThemeSwitch } from "nextra-theme-docs";

const DiscordBanner = () => {
return (
<div className="bg-gradient-to-r from-[#1D2036] from-0% via-[#2F356F] via-37% to-[#5865F2] to-100% w-full py-8">
<div className="container max-w-screen-xl h-16 mx-auto flex items-center justify-between px-4">
<div className="flex items-center">
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 127.14 96.36"
className="h-12 w-12 mr-4"
>
<path
fill="#5865f2"
d="M107.7,8.07A105.15,105.15,0,0,0,81.47,0a72.06,72.06,0,0,0-3.36,6.83A97.68,97.68,0,0,0,49,6.83,72.37,72.37,0,0,0,45.64,0,105.89,105.89,0,0,0,19.39,8.09C2.79,32.65-1.71,56.6.54,80.21h0A105.73,105.73,0,0,0,32.71,96.36,77.7,77.7,0,0,0,39.6,85.25a68.42,68.42,0,0,1-10.85-5.18c.91-.66,1.8-1.34,2.66-2a75.57,75.57,0,0,0,64.32,0c.87.71,1.76,1.39,2.66,2a68.68,68.68,0,0,1-10.87,5.19,77,77,0,0,0,6.89,11.1A105.25,105.25,0,0,0,126.6,80.22h0C129.24,52.84,122.09,29.11,107.7,8.07ZM42.45,65.69C36.18,65.69,31,60,31,53s5-12.74,11.43-12.74S54,46,53.89,53,48.84,65.69,42.45,65.69Zm42.24,0C78.41,65.69,73.25,60,73.25,53s5-12.74,11.44-12.74S96.23,46,96.12,53,91.08,65.69,84.69,65.69Z"
/>
</svg>
<div>
<h2 className="text-lg font-semibold text-white">Need Help?</h2>
<p className="text-sm max-w-72 text-gray-400">
Ask questions, get to know the project and community in Discord.
</p>
</div>
</div>
<DiscordButton />
</div>
</div>
);
};

export default DiscordBanner;
34 changes: 34 additions & 0 deletions components/DiscordButton.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from "react";

const DiscordButton: React.FC = () => {
return (
<a href="https://discord.com/invite/cv8EfJu3Tn">
<div className="flex items-center justify-center">
<button className="flex items-center bg-white border border-gray-300 rounded-lg shadow-md px-6 py-2 text-sm font-medium text-gray-800 hover:bg-gray-200 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-500">
<svg
className="h-6 w-6 mr-0 md:mr-2"
xmlns="http://www.w3.org/2000/svg"
width="800px"
height="800px"
viewBox="0 -28.5 256 256"
version="1.1"
preserveAspectRatio="xMidYMid"
>
<g>
<path
d="M216.856339,16.5966031 C200.285002,8.84328665 182.566144,3.2084988 164.041564,0 C161.766523,4.11318106 159.108624,9.64549908 157.276099,14.0464379 C137.583995,11.0849896 118.072967,11.0849896 98.7430163,14.0464379 C96.9108417,9.64549908 94.1925838,4.11318106 91.8971895,0 C73.3526068,3.2084988 55.6133949,8.86399117 39.0420583,16.6376612 C5.61752293,67.146514 -3.4433191,116.400813 1.08711069,164.955721 C23.2560196,181.510915 44.7403634,191.567697 65.8621325,198.148576 C71.0772151,190.971126 75.7283628,183.341335 79.7352139,175.300261 C72.104019,172.400575 64.7949724,168.822202 57.8887866,164.667963 C59.7209612,163.310589 61.5131304,161.891452 63.2445898,160.431257 C105.36741,180.133187 151.134928,180.133187 192.754523,160.431257 C194.506336,161.891452 196.298154,163.310589 198.110326,164.667963 C191.183787,168.842556 183.854737,172.420929 176.223542,175.320965 C180.230393,183.341335 184.861538,190.991831 190.096624,198.16893 C211.238746,191.588051 232.743023,181.531619 254.911949,164.955721 C260.227747,108.668201 245.831087,59.8662432 216.856339,16.5966031 Z M85.4738752,135.09489 C72.8290281,135.09489 62.4592217,123.290155 62.4592217,108.914901 C62.4592217,94.5396472 72.607595,82.7145587 85.4738752,82.7145587 C98.3405064,82.7145587 108.709962,94.5189427 108.488529,108.914901 C108.508531,123.290155 98.3405064,135.09489 85.4738752,135.09489 Z M170.525237,135.09489 C157.88039,135.09489 147.510584,123.290155 147.510584,108.914901 C147.510584,94.5396472 157.658606,82.7145587 170.525237,82.7145587 C183.391518,82.7145587 193.761324,94.5189427 193.539891,108.914901 C193.539891,123.290155 183.391518,135.09489 170.525237,135.09489 Z"
fill="#5865F2"
fillRule="nonzero"
/>
</g>
</svg>
<span className="hidden md:inline text-xs lg:text-xl">
Join Discord
</span>
</button>
</div>
</a>
);
};

export default DiscordButton;
2 changes: 1 addition & 1 deletion components/Feature.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const DetailedFeatureInner = (props: { feature: FeatureProps["feature"] }) => {
<Icon
className={classNames(
"h-8 w-8 dark:text-white flex-shrink-0 p-1.5 text-black block dark:stroke-[url(#pink-gradient)]",
Icon.requiresFill && "dark:fill-[url(#pink-gradient)]"
Icon.requiresFill && "dark:fill-[url(#pink-gradient)]",
)}
aria-hidden="true"
/>
Expand Down
Loading
Loading