Merge branch 'master' into add-github-workflow-for-prettier

README.md

@@ -6,7 +6,7 @@ Arbitrum Docs, built with docusaurus; docs are live at https://developer.arbitru
 
 ## Contribution
 
-For most of the docs content, you can contribute by simply opening a PR! 
+For most of the docs content, you can contribute by simply reviewing our [docs contribution guidelines](https://docs.arbitrum.io/for-devs/contribute) and opening a PR! 
 
 The following are the only exceptions: 
 

arbitrum-docs/CODEOWNERS.md

@@ -0,0 +1,13 @@
+# Learn more here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# recursively assign ownership of all files within all `third-party-docs` directories to @symbolpunk
+**/third-party-docs/  @symbolpunk
+
+# assign all contribute.md files to @symbolpunk
+**/contribute.md @symbolpunk
+
+# assign all files within `partial` folders to @symbolpunk
+**/partials/
+
+# assign ownership of `sidebars.js` to @symbolpunk
+./sidebars.js @symbolpunk

arbitrum-docs/for-devs/contribute.md

@@ -0,0 +1,8 @@
+---
+title: 'Contribute docs'
+description: "Learn how to contribute to Arbitrum's documentation"
+---
+
+import ContributeDocsPartial from '../partials/_contribute-docs-partial.md'; 
+
+<ContributeDocsPartial />

arbitrum-docs/for-users/contribute.md

@@ -0,0 +1,8 @@
+---
+title: 'Contribute docs'
+description: "Learn how to contribute to Arbitrum's documentation"
+---
+
+import ContributeDocsPartial from '../partials/_contribute-docs-partial.md'; 
+
+<ContributeDocsPartial />

arbitrum-docs/launch-orbit-chain/contribute.md

@@ -0,0 +1,8 @@
+---
+title: 'Contribute docs'
+description: "Learn how to contribute to Arbitrum's documentation"
+---
+
+import ContributeDocsPartial from '../partials/_contribute-docs-partial.md'; 
+
+<ContributeDocsPartial />

arbitrum-docs/learn-more/contribute.md

@@ -0,0 +1,8 @@
+---
+title: 'Contribute docs'
+description: "Learn how to contribute to Arbitrum's documentation"
+---
+
+import ContributeDocsPartial from '../partials/_contribute-docs-partial.md'; 
+
+<ContributeDocsPartial />

arbitrum-docs/node-running/contribute.md

@@ -0,0 +1,8 @@
+---
+title: 'Contribute docs'
+description: "Learn how to contribute to Arbitrum's documentation"
+---
+
+import ContributeDocsPartial from '../partials/_contribute-docs-partial.md'; 
+
+<ContributeDocsPartial />

website/sidebars.js

@@ -87,9 +87,9 @@ const sidebars = {
       ],
     },
     {
-      type: 'category',
-      label: 'Concepts',
-      collapsed: false,
+      type: "category",
+      label: "Concepts",
+      collapsed: true,
       items: [
         {
           type: 'doc',
@@ -157,9 +157,9 @@ const sidebars = {
       ],
     },
     {
-      type: 'category',
-      label: 'Developer tools and resources',
-      collapsed: false,
+      type: "category",
+      label: "Developer tools and resources",
+      collapsed: true,
       items: [
         {
           type: 'doc',
@@ -218,6 +218,10 @@ const sidebars = {
       label: 'Troubleshooting: Building dApps',
       id: 'for-devs/troubleshooting-building',
     },
+    {
+      type: "doc",
+      id: "for-devs/contribute"
+    },
   ],
   bridgeTokensSidebar: [
     {
@@ -235,7 +239,7 @@ const sidebars = {
       label: 'Troubleshooting: Bridge tokens',
       id: 'for-users/troubleshooting-users',
     },
-    {
+    { 
       type: "category",
       label: "Concepts",
       collapsed: false,
@@ -245,6 +249,10 @@ const sidebars = {
           id: "bridge-tokens/concepts/usdc-concept"
         }
       ]
+    },
+    {
+      type: "doc",
+      id: "for-users/contribute"
     }
   ],
   runNodesSidebar: [
@@ -327,9 +335,13 @@ const sidebars = {
       label: 'Troubleshooting: Run a node',
     },
     {
-      type: 'doc',
-      label: 'Frequently asked questions: Run a node',
-      id: 'node-running/faq',
+      type: "doc",
+      label: "Frequently asked questions: Run a node",
+      id: "node-running/faq"
+    },
+    {
+      type: "doc",
+      id: "node-running/contribute"
     },
   ],
   launchAnOrbitChainSidebar: [
@@ -493,9 +505,13 @@ const sidebars = {
       label: 'Deeper dive: Whitepaper',
     },
     {
-      type: 'doc',
-      label: 'Audit reports',
-      id: 'audit-reports',
+      type: "doc",
+      label: "Audit reports",
+      id: "audit-reports"
+    },
+    {
+      type: "doc",
+      id: "learn-more/contribute"
     },
   ],
 };

website/src/css/custom.css

@@ -358,13 +358,15 @@ article .markdown p > code {
   padding: 15px;
 }
 [class*="orbit-quickstart"] table,
-[class*="orbit-gentle-introduction"] table {
+[class*="orbit-gentle-introduction"] table,
+[class*="contribute"] table {
   font-size: 12.5px;
   margin-top: 20px;
   margin-bottom: 30px;
 }
 [class*="orbit-quickstart"] table td,
-[class*="orbit-gentle-introduction"] table td {
+[class*="orbit-gentle-introduction"] table td,
+[class*="contribute"] table td {
   padding: 10px;
 }
 [class*="quickstart-solidity-hardhat"] table {

website/src/css/custom.less

@@ -63,15 +63,15 @@
   }
 
   .troubleshooting-report-area {
-    > span {
+    >span {
       color: #ddd !important;
     }
   }
 
   .checklist {
     .task {
       .input-container {
-        input:checked + .done {
+        input:checked+.done {
           background-color: #002862;
         }
       }
@@ -81,7 +81,7 @@
           color: white;
         }
 
-        > p {
+        >p {
           color: white;
         }
       }
@@ -251,7 +251,7 @@ article {
       font-size: 30px;
     }
 
-    > h3 {
+    >h3 {
       font-size: 21px;
       margin-top: 50px;
       margin-bottom: 15px;
@@ -323,7 +323,7 @@ article {
       }
     }
 
-    p > code {
+    p>code {
       font-size: 13px;
       padding: 3px 6px;
       border-radius: 3px;
@@ -343,7 +343,8 @@ article {
 }
 
 [class*="orbit-quickstart"],
-[class*="orbit-gentle-introduction"] {
+[class*="orbit-gentle-introduction"],
+[class*="contribute"] {
   table {
     .small-table;
   }
@@ -443,7 +444,7 @@ article {
       margin: 0;
       font-family: monospace;
 
-      > span:first-child {
+      >span:first-child {
         font-weight: 600;
         padding-right: 5px;
       }
@@ -488,7 +489,7 @@ article {
 
 .features_src-components-HomepageFeatures-styles-module,
 .landingPageLink_aBTe {
-  .text--center > h3 {
+  .text--center>h3 {
     margin-top: 10px;
     margin-bottom: 5px;
   }
@@ -611,26 +612,26 @@ article {
 .troubleshooting-report-area {
   text-align: left;
 
-  > p {
+  >p {
     font-weight: bold;
     margin-bottom: 0;
     margin-top: 0;
     font-size: 16px;
   }
 
-  > span {
+  >span {
     display: block;
     margin-bottom: 0;
     margin-top: 0;
     font-size: 13px;
     color: #333;
   }
 
-  > code {
+  >code {
     font-size: 13px;
   }
 
-  > textarea {
+  >textarea {
     .invisible-horizontal-scroll;
     padding: 15px;
     font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono",
@@ -724,7 +725,7 @@ article {
         transition-delay: 0s;
       }
 
-      input:checked + .done {
+      input:checked+.done {
         position: absolute;
         top: 0;
         bottom: 0;
@@ -747,7 +748,7 @@ article {
         font-weight: bold;
       }
 
-      > p,
+      >p,
       p {
         font-size: 14px;
         line-height: 20px;
@@ -772,6 +773,7 @@ article {
 // #endregion
 
 [data-faq-origin-slug="node-faq"] {
+
   /* CSS properties */
   h3 {
     font-size: 16px;
@@ -820,7 +822,7 @@ h2.anchor {
     font-size: 24px;
   }
 
-  .markdown > h3 {
+  .markdown>h3 {
     font-size: 18px;
     margin-top: 35px;
     margin-bottom: 10px;
@@ -842,4 +844,4 @@ article a:not([data-quicklook-from]):not(.footnote-ref) {
   line-height: 1.5;
   padding-top: 0;
   padding-bottom: 0;
-}
+}