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

style: new UI & refactoring #51

Merged
merged 65 commits into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
9a5a42f
update guides page UI
sarahschwartz Sep 7, 2023
256bc76
progress
sarahschwartz Sep 8, 2023
3a17ccc
Merge branch 'master' into sarah/ui
sarahschwartz Sep 8, 2023
2478d64
refactor nav links
sarahschwartz Sep 8, 2023
a857e71
fix
sarahschwartz Sep 8, 2023
f7edec3
progress
sarahschwartz Sep 9, 2023
e474947
progress
sarahschwartz Sep 11, 2023
c7b7350
progress
sarahschwartz Sep 12, 2023
f76069f
Merge branch 'master' into sarah/ui
sarahschwartz Sep 25, 2023
2b765b1
test global nav
sarahschwartz Sep 25, 2023
f9ab1a7
cleanup
sarahschwartz Sep 25, 2023
ccc9f2d
breadcrumbs, prev&next buttons, nav updates
sarahschwartz Sep 26, 2023
67e9780
Merge branch 'master' into sarah/ui
sarahschwartz Sep 27, 2023
595e003
progress
sarahschwartz Oct 9, 2023
df0f8cb
Merge branch 'master' into sarah/ui
sarahschwartz Oct 12, 2023
5add21f
progress
sarahschwartz Oct 13, 2023
79a7bf9
cleanup
sarahschwartz Oct 13, 2023
48aa93d
progress
sarahschwartz Oct 13, 2023
2738908
progress
sarahschwartz Oct 13, 2023
0fab604
fixes
sarahschwartz Oct 16, 2023
89c8428
fixes
sarahschwartz Oct 16, 2023
1f6cf4e
refactors
sarahschwartz Oct 16, 2023
13adfec
add new search
sarahschwartz Oct 16, 2023
dc3c62b
Merge branch 'master' into sarah/ui
sarahschwartz Oct 16, 2023
365de32
fix dark mode search
sarahschwartz Oct 16, 2023
e74ca58
Merge branch 'master' into sarah/ui
sarahschwartz Oct 27, 2023
64a11b4
progress
sarahschwartz Oct 27, 2023
2fab73c
progress
sarahschwartz Oct 30, 2023
e7b16bf
progress
sarahschwartz Oct 30, 2023
c84c2a1
Merge branch 'master' into sarah/ui
sarahschwartz Oct 30, 2023
bf4267a
progress
sarahschwartz Nov 1, 2023
a6db211
fixes
sarahschwartz Nov 1, 2023
7f9665e
update font & tables
sarahschwartz Nov 1, 2023
4d8c229
fix table color
sarahschwartz Nov 1, 2023
3594b21
fix
sarahschwartz Nov 1, 2023
35e04a8
add draft intro section
sarahschwartz Nov 1, 2023
1c4fe5c
draft intro section
sarahschwartz Nov 2, 2023
dfe6283
fix lint
sarahschwartz Nov 2, 2023
76c3007
Merge branch 'master' into sarah/ui
sarahschwartz Nov 2, 2023
c4f7d98
update intro
sarahschwartz Nov 3, 2023
8a352e1
cleanup, fixes
sarahschwartz Nov 3, 2023
d3fa0d1
fix lint
sarahschwartz Nov 3, 2023
686cbdb
fix mobile padding
sarahschwartz Nov 3, 2023
b235c2d
add space
sarahschwartz Nov 3, 2023
e19cab4
remove breadcrumbs, fixes
sarahschwartz Nov 3, 2023
bfdb7dc
Merge branch 'master' into sarah/ui
sarahschwartz Nov 6, 2023
7cd7b40
refactor breadcrumbs
sarahschwartz Nov 7, 2023
1b9f1f2
cleanup
sarahschwartz Nov 8, 2023
1eab855
update search results color
sarahschwartz Nov 8, 2023
bae4ae1
reorder header, nits
sarahschwartz Nov 8, 2023
1432edf
fix
sarahschwartz Nov 8, 2023
bc066f3
fixes
sarahschwartz Nov 8, 2023
f460d61
fix
sarahschwartz Nov 8, 2023
91ce8fe
fix
sarahschwartz Nov 8, 2023
ab87678
Merge branch 'master' into sarah/ui
sarahschwartz Nov 8, 2023
a5a07e9
fix versions
sarahschwartz Nov 8, 2023
62e965e
Merge branch 'master' into sarah/ui
sarahschwartz Nov 9, 2023
a07434d
style: nav font size, table styling
sarahschwartz Nov 10, 2023
d294add
fix: audit
sarahschwartz Nov 10, 2023
a0eb5c2
Merge branch 'master' into sarah/ui
sarahschwartz Nov 13, 2023
c2387a0
refactor sidebar names
sarahschwartz Nov 14, 2023
830b6a0
fix guides parent label
sarahschwartz Nov 14, 2023
ef4d95d
change nav order
sarahschwartz Nov 15, 2023
3b65737
remove dates from guides
sarahschwartz Nov 16, 2023
f300196
Merge branch 'master' into sarah/ui
sarahschwartz Nov 16, 2023
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
3 changes: 3 additions & 0 deletions contentlayer.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ const MdDoc = defineDocumentType(() => ({
parent: {
type: 'nested',
of: ParentType,
required: false,
},
},
computedFields: {
Expand All @@ -59,6 +60,7 @@ const includeDirs = [
'docs/fuel-graphql-docs/docs',
'docs/fuels-wallet/packages/docs/docs',
'docs/guides/docs',
'docs/intro',
// 'docs/fuel-nix/book/src',
// 'docs/about-fuel',
'docs/latest/sway/docs/book/src',
Expand All @@ -76,6 +78,7 @@ const includeDirs = [
const excludeDirs = [
'docs/guides/docs/guides.json',
'docs/guides/docs/nav.json',
'docs/intro/nav.json',
// 'docs/about-fuel/nav.json',
'docs/sway/docs/book/src/SUMMARY.md',
'docs/sway/docs/book/src/forc/commands/forc_deploy.md',
Expand Down
1 change: 1 addition & 0 deletions docs/guides/docs/categories.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const TAG_CATEGORIES = ['Getting Started', 'Full Stack', 'fuel-core'];
44 changes: 26 additions & 18 deletions docs/guides/docs/guides.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
{
"installation": {
"title": "Toolchain Installation",
"description": "Install the Fuel toolchain and binaries."
},
"quickstart": {
"title": "Developer Quickstart",
"description": "Get started by building a counter dApp in Fuel."
},
"running_a_node": {
"title": "Running a Node",
"description": "Run a local Fuel node."
},
"migration_guide": {
"title": "Migration Guide",
"description": "Sway and SDK's breaking changes reference."
}
}
{
"installation": {
"title": "Toolchain Installation",
"description": "Install the Fuel toolchain and binaries.",
"featured": true,
"tags": ["Getting Started"]
},
"quickstart": {
"title": "Developer Quickstart",
"description": "Get started by building a counter dApp in Fuel.",
"featured": true,
"tags": ["Getting Started", "Full Stack"]
},
"running_a_node": {
"title": "Running a Node",
"description": "Run a local Fuel node.",
"featured": false,
"tags": ["fuel-core"]
},
"migration_guide": {
"title": "Migration Guide",
"description": "Sway and SDK's breaking changes reference.",
"featured": false,
"tags": []
}
}
2 changes: 1 addition & 1 deletion docs/guides/docs/installation/codespace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Fuel Github Codespace
category: Installation
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/installation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Installation
category: Installation
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/migration-guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Migration Guide
category: Migration Guide
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/migration-guide/testnet-migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Testnet Migration
category: Migration Guide
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/quickstart/building-a-frontend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Building a Frontend
category: Quickstart
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/quickstart/building-a-smart-contract.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Building a Smart Contract
category: Quickstart
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/quickstart/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Quickstart
category: Quickstart
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/running-a-node/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Running a Node
category: Running a Node
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/running-a-node/running-a-beta-4-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Running a Beta-4 Node
category: Running a Node
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/docs/running-a-node/running-a-local-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Running a Local Node
category: Running a Node
parent:
label: Guides
label: All Guides
link: /guides
---

Expand Down
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/intro/nav.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"menu": ["What is Fuel", "Quickstart Contract", "Quickstart Frontend", "Glossary"]
}
3 changes: 3 additions & 0 deletions docs/intro/quickstart-contract.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Quickstart Contract

{/*this content is automatically replaced with the quickstart guide*/}
3 changes: 3 additions & 0 deletions docs/intro/quickstart-frontend.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Quickstart Frontend

{/*this content is automatically replaced with the quickstart guide*/}
195 changes: 195 additions & 0 deletions docs/intro/what-is-fuel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
# What is Fuel?

Fuel v1 began as a layer-2 (L2) scalability technology for a monolithic Ethereum.
It was the first optimistic rollup on mainnet Ethereum, deployed at the end of 2020.

Today, Fuel is the fastest modular execution layer.
Fuel delivers the highest security and flexible throughput, focusing on a superior developer experience.

Here is how we do it:

## FuelVM

The FuelVM learns from the Ethereum ecosystem.
It implements improvements suggested to the Ethereum VM (EVM) for many years that couldn’t be implemented due to the need to maintain backward compatibility, including parallel transaction execution and multiple native assets.

Fuel delivers unmatched processing capacity through its ability to execute transactions in parallel by using strict state access lists in the form of a UTXO model.
With the FuelVM, Fuel full nodes identify the accounts a transaction touches, mapping out dependencies before execution.
This enables Fuel to use far more threads and cores of your CPU that are typically idle in single-threaded blockchains.
As a result, Fuel can deliver far more compute, state accesses, and transactional throughput than its single-threaded counterparts.

## Sway Language

Fuel provides a powerful and sleek developer experience with our own domain-specific language (DSL) called Sway.
Sway is based on Rust and includes syntax to leverage a blockchain VM without needlessly verbose boilerplate.
Sway was created alongside the FuelVM and designed for the high-compute Fuel environment.

### Rust + Solidity = Sway

Sway prioritizes compile-time analysis and safety, similar to Rust’s borrow checker and safety-first semantics.
Additionally, it has the syntax of Rust. From Solidity, Sway took the notion of a smart-contract-paradigm language with built-in top-level contract storage and blockchain mechanisms for ergonomic and safe contract programming.

Sway brings the notion of static auditing to smart contracts.
In addition, Sway is highly performant and has extensible optimization passes and a modular backend for targeting different blockchain architectures.

<CardSection
isLatest={props.isLatest}
cardsInfo={[
{
link: '/docs/sway',
latestLink: '/docs/latest/sway',
isExternal: false,
heading: 'Sway',
headingIcon: 'Code',
body: 'Read the official Sway documentation.',
},
{
link: 'https://github.com/FuelLabs/sway-applications',
isExternal: true,
heading: 'Sway Playground',
headingIcon: 'Browser',
body: 'Get started experimenting with Sway in the browser.',
},
{
link: 'https://fuellabs.github.io/sway/master/std/',
isExternal: true,
heading: 'Sway Standard Lib',
headingIcon: 'Book',
body: 'Find definitions for helpful types and methods in Sway.',
},
{
link: 'https://github.com/FuelLabs/sway-applications',
isExternal: true,
heading: 'Example Applications',
headingIcon: 'Apps',
body: 'Explore end-to-end applications written in Sway.',
}
]}
/>

## Developer Tooling

Part of what makes Sway so powerful is the fantastic suite of developer tools surrounding it.
The Fuel development environment retains the benefits of smart contract languages like Solidity, while adopting the paradigms introduced in the Rust tooling ecosystem.

Now, developers can have a completely vertically integrated experience where every component, from the virtual machine to the CLI, works in harmony.

### Sway Tooling

<CardSection
isLatest={props.isLatest}
cardsInfo={[
{
link: '/docs/forc',
latestLink:'/docs/latest/forc',
isExternal: false,
heading: 'Forc',
headingIcon: 'Tool',
body: 'Explore the Fuel Orchestrator that helps you build, test, and deploy your Sway projects.',
},
{
link: '/docs/fuelup',
latestLink: '/docs/latest/fuelup',
isExternal: false,
heading: 'Fuelup',
headingIcon: 'Settings',
body: 'Learn more about the official Fuel toolchain manager that helps install and manage versions.',
}
]}
/>

### SDKs & API

<CardSection
isLatest={props.isLatest}
cardsInfo={[
{
link: '/docs/fuels-rs',
latestLink: '/docs/latest/fuels-rs',
isExternal: false,
heading: 'Rust SDK',
headingIcon: 'BrandRust',
body: 'Test and interact with your Sway program in Rust.',
},
{
link: '/docs/fuels-ts',
latestLink: '/docs/latest/fuels-ts',
isExternal: false,
heading: 'Typescript SDK',
headingIcon: 'BrandTypescript',
body: 'Test and interact with your Sway program in TypeScript.',
},
{
link: '/docs/wallet',
latestLink: '/docs/latest/wallet',
isExternal: false,
heading: 'Wallet SDK',
headingIcon: 'Wallet',
body: 'Seamlessly integrate a wallet into your application.',
},
{
link: '/docs/graphql',
latestLink: '/docs/latest/graphql',
isExternal: false,
heading: 'GraphQL API',
headingIcon: 'ChartDots3',
body: 'Learn about the GraphQL API and interact with the Fuel Network.',
},
]}
/>

### Indexer

<CardSection
isLatest={props.isLatest}
cardsInfo={[
{
link: '/docs/indexer',
latestLink: '/docs/indexer',
isExternal: false,
heading: 'Indexer',
headingIcon: 'LayoutGrid',
body: 'Build and deploy an indexer to organize and query on-chain data.',
},
]}
/>

### Network

Fuel is currently live on testnet only.
The latest testnet network is the {props.fuelTestnetInlineCode} testnet.

<CardSection
isLatest={props.isLatest}
cardsInfo={[
{
link: `/docs/specs`,
latestLink: `/docs/latest/specs`,
isExternal: false,
heading: 'Specs',
headingIcon: 'ListDetails',
body: 'Explore the specifications for the Fuel Network.',
},
{
link: props.explorerUrl,
isExternal: true,
heading: 'Explorer',
headingIcon: 'Search',
body: 'Explore transactions on the Fuel network.',
},
{
link: props.bridgeUrl,
isExternal: true,
heading: 'Bridge',
headingIcon: 'BuildingBridge',
body: 'Bridge assets to the Fuel network.',
},
{
link: props.faucetUrl,
isExternal: true,
heading: 'Faucet',
headingIcon: 'Coin',
body: `Get ${props.fuelTestnet} testnet tokens.`,
}
]}
/>
6 changes: 6 additions & 0 deletions scripts/generate-links/getDocs.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,12 @@ export async function getDocs(key, order) {
'./guides/docs/migration-guide/breaking-change-log/breaking-changes-log.md',
];
break;
case 'intro':
paths = [
// INTRO
'./intro/*.mdx',
];
break;
// case 'latest-guides':
// paths = [
// // LATEST GUIDES
Expand Down
Loading
Loading