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

[docs] docs migration #34096

Merged
merged 103 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
103 commits
Select commit Hold shift + click to select a range
357a924
feat: moved common docs to repo
nickfrosty Oct 6, 2023
9ace3fe
refactor: removed sidebar items
nickfrosty Nov 7, 2023
9170af1
refactor: removed unused images
nickfrosty Nov 7, 2023
ba74ff7
fix: terminology link
nickfrosty Nov 7, 2023
e35c436
fix: introduction links
nickfrosty Nov 7, 2023
caf3c62
fix: developing links
nickfrosty Nov 7, 2023
d53713c
refactor: fixed assorted links
nickfrosty Nov 7, 2023
19863e0
fix: added back the home index
nickfrosty Nov 7, 2023
8af6af8
refactor: home page links
nickfrosty Nov 7, 2023
0a3ab4a
refactor: primary links
nickfrosty Nov 7, 2023
2683492
fix: links
nickfrosty Nov 7, 2023
2b2e72d
fix: updated existing redirects
nickfrosty Nov 7, 2023
a66b5c1
feat: added new redirects
nickfrosty Nov 7, 2023
d95bba0
refactor: moved cli index file to cli folder
nickfrosty Nov 13, 2023
c7232cf
feat: turned breadcrumbs on
nickfrosty Nov 13, 2023
a8bf663
feat: auto generated cli sidebar
nickfrosty Nov 13, 2023
ed9c5eb
refactor: page titles
nickfrosty Nov 13, 2023
86b8f18
feat: added usage and wallets categories
nickfrosty Nov 13, 2023
24dd9b8
refactor: moved wallet-guide/cli
nickfrosty Nov 13, 2023
0dafb4b
style: page titles
nickfrosty Nov 13, 2023
a700d24
refactor: renamed file to install
nickfrosty Nov 13, 2023
cc529fa
style: page title
nickfrosty Nov 13, 2023
853b396
refactor: relocated file to cli/usage/index.md
nickfrosty Nov 13, 2023
26e3da6
style: page title
nickfrosty Nov 13, 2023
cc3033d
refactor: relocat detailed usage generator for cli commands
nickfrosty Nov 13, 2023
bdcb4ab
refactor: relocated clie usage files
nickfrosty Nov 13, 2023
1b30582
refactor: relocated paper wallet file
nickfrosty Nov 13, 2023
4b946fc
refactor: relocated file system wallet doc
nickfrosty Nov 13, 2023
bacb688
feat: added hardware wallet category
nickfrosty Nov 13, 2023
2ad012e
refactor: relocated hardware wallet overview
nickfrosty Nov 13, 2023
09c651a
refactor: relocated ledger wallet doc
nickfrosty Nov 13, 2023
6793ec5
style: clie wallet titles
nickfrosty Nov 13, 2023
c9e0066
refactor(revert): relocated cli usage doc
nickfrosty Nov 13, 2023
991a4b8
refactor: relocated to examples
nickfrosty Nov 13, 2023
8e221a2
style: cli examples category title
nickfrosty Nov 13, 2023
3f4cd30
style: usage doc title
nickfrosty Nov 13, 2023
b36c577
refactor: relocated cli intro doc
nickfrosty Nov 13, 2023
ba0457c
style: category title
nickfrosty Nov 13, 2023
cc12d66
refactor: renamed file
nickfrosty Nov 13, 2023
818013c
refactor: renamed file
nickfrosty Nov 13, 2023
b365a4a
fix: cli links
nickfrosty Nov 13, 2023
b13ce5c
refactor: relocated file
nickfrosty Nov 13, 2023
9f4ac4d
refactor: relocated files
nickfrosty Nov 13, 2023
daf7dd0
fix: more cli links
nickfrosty Nov 13, 2023
e0432c7
refactor: sidebar order
nickfrosty Nov 13, 2023
1fed4e2
fix: final cli links?
nickfrosty Nov 13, 2023
64b6a23
refactor: proposals
nickfrosty Nov 13, 2023
44bf9c7
refactor: split sidebars
nickfrosty Nov 13, 2023
bdfa3d2
refactor: removed unused icons
nickfrosty Nov 13, 2023
72d8c14
refactor: relocated file
nickfrosty Nov 14, 2023
a04d984
refactor: relocated file
nickfrosty Nov 14, 2023
b2a9b8a
refactor: relocated file
nickfrosty Nov 14, 2023
417dad3
refactor: relocated file
nickfrosty Nov 14, 2023
0236a51
feat: added architecture page
nickfrosty Nov 14, 2023
d3fa2d0
refactor: reloacted filed
nickfrosty Nov 14, 2023
810a688
refactor: adjusted header links
nickfrosty Nov 14, 2023
3e79732
style: sidebar labels
nickfrosty Nov 14, 2023
8ef22ab
feat: clusters sidebar details
nickfrosty Nov 14, 2023
9a2a032
style: sidebar label
nickfrosty Nov 14, 2023
e9248a2
refactor: relocate file
nickfrosty Nov 14, 2023
4e74fe9
refactor: relocated files
nickfrosty Nov 14, 2023
79a3dd5
refactor: relocated files
nickfrosty Nov 14, 2023
95725fe
refactor: relocated files
nickfrosty Nov 14, 2023
d491b0e
style: validator sidebar
nickfrosty Nov 14, 2023
fa44b6d
style: sidebar styles
nickfrosty Nov 15, 2023
40ee349
refactor: internal links
nickfrosty Nov 15, 2023
792cd62
style: sidebar order
nickfrosty Nov 15, 2023
a0ab7d2
fix: internal links
nickfrosty Nov 15, 2023
82d244b
feat: master sidebar
nickfrosty Nov 15, 2023
af37003
refactor: removed unneeded h2
nickfrosty Nov 15, 2023
9ec8778
fix: link redirects
nickfrosty Nov 15, 2023
a0801e6
refactor: relocated pages
nickfrosty Nov 15, 2023
9e8b902
style: runtime links
nickfrosty Nov 15, 2023
302919e
refactor: simplified runtime redirects
nickfrosty Nov 15, 2023
c56d844
fix: internal redirect
nickfrosty Nov 15, 2023
ed1f058
refactor: moved proposals to dropdown
nickfrosty Nov 15, 2023
020a65c
docs: Removes accounts-on-ramdisk section (#33655)
brooksprumo Oct 11, 2023
812d8d5
RPC: update websocket docs (#33460)
buffalojoec Oct 16, 2023
e8e87d5
Change getHealth to compare optimistically confirmed slots (#33651)
steviez Oct 16, 2023
6601960
build(deps): bump @babel/traverse from 7.19.6 to 7.23.2 in /docs (#33…
dependabot[bot] Oct 17, 2023
357e574
docs: move rpc info to rpc docs (#33723)
jacobcreech Oct 17, 2023
a155738
Fix typos in documentation for Secp256k1 native program (#33796)
nickguo Oct 23, 2023
de1eb73
docs: outline requirement of stake in order to vote (#33842)
AshwinSekar Oct 25, 2023
a782ee0
chore: fix some typos (#33833)
kevinheavey Oct 25, 2023
eda8681
docs: updating apt install to apt upgrade (#33920)
kaplanmaxe Nov 6, 2023
012bcfa
Fix some typo in the documentation (#34058)
hugo-syn Nov 14, 2023
dd33d05
Merge branch 'master' into docs-migration
nickfrosty Nov 15, 2023
ae3a745
fix: internal links
nickfrosty Nov 15, 2023
067c2d2
refactor: removed rpc api docs
nickfrosty Nov 16, 2023
96c5f42
refactor: removed rpc sidebar
nickfrosty Nov 17, 2023
39bbc3c
fix: updated remaining rpc api links
nickfrosty Nov 17, 2023
8c8f908
refactor: removed final rpc /api route
nickfrosty Nov 17, 2023
530aaee
refactor: removed dangling component files
nickfrosty Nov 17, 2023
aaf40d5
refactor: changed copyright
nickfrosty Nov 28, 2023
5332653
fix: dangling ordered list
nickfrosty Nov 30, 2023
6845c02
refactor: wording around solana docs
nickfrosty Dec 1, 2023
8949881
feat: home page content
nickfrosty Dec 1, 2023
9194339
refactor: updated docs url
nickfrosty Dec 1, 2023
8695582
Link to latest version of the off-chain message signing proposal in t…
nickfrosty Dec 7, 2023
3b29a5a
docs: (cli) minor updates to deploy-a-program.md (#34307)
norwnd Dec 7, 2023
705f317
Merge branch 'master' into docs-migration
nickfrosty Dec 8, 2023
60245b4
Merge branch 'master' into docs-migration
nickfrosty Dec 11, 2023
f5314ea
refactor: removed GA
nickfrosty Dec 11, 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: 0 additions & 3 deletions docs/.prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,3 @@
build
html
static

# prettier interferes with the json response too much
src/developing/clients/jsonrpc-api.md
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Solana Docs Readme
# Solana Validator Docs Readme

Solana's Docs are built using [Docusaurus v2](https://v2.docusaurus.io/) with `npm`.
This validator's docs are built using [Docusaurus v2](https://v2.docusaurus.io/) with `npm`.
Static content delivery is handled using `vercel`.

## Local Development

To set up the Solana Docs site locally:
To set up the Solana Validator Docs site locally:

- install dependencies using `npm`
- build locally via `./build.sh`
Expand All @@ -30,7 +30,7 @@ The build script generates static content into the `build` directory and can be
./build.sh
```

Running this build script requires **Docker**, and will auto fetch the [solanalabs/rust](https://hub.docker.com/r/solanalabs/rust) image from Docker hub to compile the desired version of the [Solana CLI](https://docs.solana.com/cli) from source.
Running this build script requires **Docker**, and will auto fetch the [solanalabs/rust](https://hub.docker.com/r/solanalabs/rust) image from Docker hub to compile the desired version of the [Solana CLI](https://docs.solanalabs.com/cli) from source.

This build script will also:

Expand Down Expand Up @@ -75,9 +75,9 @@ The docs are built and published in Travis CI with the `./build.sh` script. On e

In each post-commit build, docs are built and published using `vercel` to their respective domain depending on the build branch.

- Master branch docs are published to `edge.docs.solana.com`
- Beta branch docs are published to `beta.docs.solana.com`
- Latest release tag docs are published to `docs.solana.com`
- Master branch docs are published to `edge.docs.solanalabs.com`
- Beta branch docs are published to `beta.docs.solanalabs.com`
- Latest release tag docs are published to `docs.solanalabs.com`

## Common Issues

Expand Down
2 changes: 1 addition & 1 deletion docs/build-cli-usage.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ out=${1:-src/cli/usage.md}
# load the usage file's header
cat src/cli/.usage.md.header > "$out"

# Skip generating the usage doc for non deployment commits of the docs
# Skip generating the detailed usage doc for non deployment commits of the docs
if [[ -n $CI ]]; then
if [[ $CI_BRANCH != $EDGE_CHANNEL* ]] && [[ $CI_BRANCH != $BETA_CHANNEL* ]] && [[ $CI_BRANCH != $STABLE_CHANNEL* ]]; then
echo "**NOTE:** The usage doc is only auto-generated during full production deployments of the docs"
Expand Down
161 changes: 0 additions & 161 deletions docs/components/CodeDocBlock.jsx

This file was deleted.

8 changes: 4 additions & 4 deletions docs/components/HomeCtaLinks.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ export default function HomeCtaLinks() {
<div className="container">
<div className="row cards__container">
<Card
to="developers"
to="https://solana.com/developers"
header={{
label: "Developers",
translateId: "cta-developers",
}}
/>

<Card
to="running-validator"
to="operations"
header={{
label: "Validators",
label: "Operate a Validator",
translateId: "cta-validators",
}}
/>

<Card
to="cluster/overview"
to="clusters"
header={{
label: "Architecture",
translateId: "cta-architecture",
Expand Down
66 changes: 24 additions & 42 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
const math = require("remark-math");
const katex = require("rehype-katex");
module.exports = {
title: "Solana Docs",
title: "Solana Validator",
tagline:
"Solana is an open source project implementing a new, high-performance, permissionless blockchain.",
url: "https://docs.solana.com",
url: "https://docs.solanalabs.com",
baseUrl: "/",
favicon: "img/favicon.ico",
organizationName: "solana-labs", // Usually your GitHub org/user name.
Expand Down Expand Up @@ -55,43 +55,29 @@ module.exports = {
srcDark: "img/logo-horizontal-dark.svg",
},
items: [
{
to: "introduction",
label: "Learn",
position: "left",
},
{
to: "cluster/overview",
label: "Architecture",
position: "left",
},
{
to: "cli",
label: "CLI",
position: "left",
},
{
to: "/developers",
label: "Developers",
to: "architecture",
label: "Architecture",
position: "left",
},
{
to: "running-validator",
label: "Validators",
to: "operations",
label: "Operating a Validator",
position: "left",
},
{
label: "More",
position: "left",
items: [
{ label: "Terminology", to: "terminology" },
{ label: "Staking", to: "staking" },
{ label: "Integrations", to: "integrations/exchange" },
{ label: "Economics", to: "economics_overview" },
{ label: "Proposals", to: "proposals" },
{
href: "https://spl.solana.com",
label: "Solana Program Library »",
label: "Solana Program Library",
},
],
},
Expand Down Expand Up @@ -129,24 +115,20 @@ module.exports = {
title: "Documentation",
items: [
{
label: "Learn",
to: "introduction",
},
{
label: "Developers",
to: "/developers",
label: "Developers »",
href: "https://solana.com/developers",
},
{
label: "Validators",
to: "running-validator",
label: "Running a Validator",
to: "operations",
},
{
label: "Command Line",
to: "cli",
},
{
label: "Architecture",
to: "cluster/overview",
to: "architecture",
},
],
},
Expand All @@ -167,7 +149,7 @@ module.exports = {
},
{
label: "Twitter »",
href: "https://twitter.com/solana",
href: "https://solana.com/twitter",
},
{
label: "Forum »",
Expand All @@ -179,12 +161,12 @@ module.exports = {
title: "Resources",
items: [
{
label: "Proposals",
to: "proposals",
label: "Terminology »",
href: "https://solana.com/docs/terminology",
},
{
label: "Integrations",
to: "integrations/exchange",
label: "Proposals",
to: "proposals",
},
{
href: "https://spl.solana.com",
Expand All @@ -193,7 +175,7 @@ module.exports = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Solana Foundation`,
copyright: `Copyright © ${new Date().getFullYear()} Solana Labs`,
},
},
presets: [
Expand All @@ -202,7 +184,7 @@ module.exports = {
{
docs: {
path: "src",
breadcrumbs: false,
breadcrumbs: true,
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
remarkPlugins: [math],
Expand All @@ -212,11 +194,11 @@ module.exports = {
customCss: require.resolve("./src/css/custom.css"),
},
// Google Analytics are only active in prod
gtag: {
// this GA code is safe to be published
trackingID: "G-94WS0LRZRS",
anonymizeIP: true,
},
// gtag: {
// this GA code is safe to be published
// trackingID: "",
// anonymizeIP: true,
// },
},
],
],
Expand Down
Loading